@findy/react-findy-id

React container for Findy ID.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
210May 27, 2021Jul 23, 2018Minified + gzip package size for @findy/react-findy-id in KB

Readme

CircleCI

React Findy ID

How to use

Install package

yarn

yarn add @findy/react-findy-id

npm

npm install @findy/react-findy-id --save

Put Sign-in button

Import React component

import { FindyIdComponent } from '@findy/react-findy-id'

and put Sign-in button on your app.

<FindyIdComponent
  afterSignInSuccessCallback={afterSignInSuccessCallback}
  signInSuccessUrl="http://localhost:3001"
  tosUrl="https://findy-code.io/terms"
  privacyPolicyUrl="https://findy-code.io/policy"
/>

props

Name type Description
afterSignInSuccessCallback Function Callback after sign-in, before redirect. The parameter authResult is a firebase authentication result object.
signInSuccessUrl String Redirect URL after sign-in.
tosUrl String Term of Service URL.
privacyPolicyUrl String Privacy Policy URL.

For package developers

Setup

  • git clone https://github.com/Findy/react-findy-id.git
  • npm install
  • cp .env.example .env
  • Edit the .env file.

Run on local example app

  • npm start
  • Open http://localhost:3001

Directory structures

  • build
    • Output of build.
  • examples
    • Example app which is used by package developer.
  • src
    • Main code.

Publish

  • git checkout master
  • npm version [major | minor | patch]
  • git push origin master
  • git push origin vX.X.X
  • npm publish --access=public

localization

  • git clone https://github.com/firebase/firebaseui-web.git
  • cd firebaseui-web
  • Replace でログイン to でログイン/登録 in translations/ja.xtb file.
  • npm install
  • npm run build build-npm-ja
  • cp dist/npm__ja.js <react-findy-id directory>/lib

Ref. https://github.com/firebase/firebaseui-web/issues/379#issuecomment-417684828

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.