Code Monkey home page Code Monkey logo

react-github-button's Introduction

react-github-login-button

Getting Started

react-github-login-button is universal, so it can be used client-side or server-side.

  1. Install through: npm install --save react-github-login-button

  2. Import GithubButton from react-github-login-button:

    import GithubButton from 'react-github-login-button'
  3. Use GithubButton component:

    <GithubButton
      onClick={() => { console.log('Github button clicked') }}
    />

Props

type

PropType
oneOf([ 'light', 'dark' ])
Default
'dark'
Example
<GithubButton
  type="light" // can be light or dark
  onClick={() => { console.log('Github button clicked') }}
/>
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.log('this will not run on click since it is disabled') }}
/>

label

PropType
String
Default
'Sign in with Github'
Example
<GithubButton
  label='Be Cool'
  onClick={() => { console.log('Github button clicked') }}
/>
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:

<script src="../node_modules/react-github-login-button/dist/react-github-login-button.min.js"></script>
<!-- or through cdn: <script src="https://unpkg.com/react-github-login-button@latest/dist/react-github-login-button.min.js"></script> -->
<script>console.log('redux firestore:', window.ReactGithubButton)</script>

Note: In an effort to keep things simple, the wording from this explanation was modeled after the installation section of the Redux Docs.

react-github-button's People

Contributors

githubgreg avatar goto-bus-stop avatar kmsheng avatar prescottprue avatar rabidfire avatar sbolel avatar timc13 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.