react-github-login-button
Getting Started
react-github-login-button
is universal, so it can be used client-side or server-side.
-
Install through:
npm install --save react-github-login-button
-
Import
GithubButton
fromreact-github-login-button
: -
Use
GithubButton
component:<GithubButtononClick= { console }/>
Props
type
PropType
Default
'dark'
Example
<GithubButton type="light" // can be light or dark onClick= { console }/>
Description
'light'
or 'dark'
for the different github styles (defaults to dark
)
disabled
disabled
- whether or not button is disabled
PropType
Boolean
Default
false
Example
<GithubButton disabled // can also be written as disabled={true} for clarity onClick= { console }/>
label
PropType
String
Default
'Sign in with Github'
Example
<GithubButton label='Be Cool' onClick= { console }/>
Description
Override the 'Sign in with Github' words with another string.
Builds
Most commonly people consume react-github-login-button
as a CommonJS module. This module is what you get when you import redux in a Webpack, Browserify, or a Node environment.
If you don't use a module bundler, it's also fine. The react-github-login-button
npm package includes precompiled production and development UMD builds in the dist folder. They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. For example, you can drop a UMD build as a <script>
tag on the page. The UMD builds make Redux Firestore available as a window.ReduxFirestore
global variable.
It can be imported like so:
<!-- or through cdn: <script src="https://unpkg.com/react-github-login-button@latest/dist/react-github-login-button.min.js"></script> -->
Note: In an effort to keep things simple, the wording from this explanation was modeled after the installation section of the Redux Docs.