Code Monkey home page Code Monkey logo

react-barong's Introduction

Cryptocurrency Exchange Platform - OpenDAX

Guide | API Docs | Consulting | Community

Barong is part of OpenDAX Trading Platform

react-barong

NPM JavaScript Style Guide

Barong React Authentication components for barong

Installation

If you want to add package to your project run:

npm install --save react-barong

Glossary

BarongLoginForm

Login form

Name Type Required Description Default
redirection string Yes Redirection URL after successful submit.
host string Yes Barong host string. Example: https://foo-exchange.com/api/v2.
testMode boolean No If test mode is true, the submit is fired without calling the barong API.
forgotPasswordUrl string No If set, the forgot password lint will be appeared.
confirmationEmailSentText string No Text which appear after confirmation email is sent. Your email is not verified. We sent you confirmation link.

BarongRegisterForm

Register form

Name Type Required Description
redirection string Yes Redirection URL after successful submit.
host string Yes Barong host string. Example: https://foo-exchange.com/api/v2.
testMode boolean No If test mode is true, the submit is fired without calling the barong API.

BarongLogoutButton

Log out button

Name Type Required Description
redirection string Yes Redirection URL after successful submit.
host string Yes Barong host string. Example: https://foo-exchange.com/api/v2.
testMode boolean No If test mode is true, the submit is fired without calling the barong API.
render (options: LogoutButtonProps) => React.ReactElement No Renders custom button
text string No Buttons string content. Default value: Log Out

LogoutButtonProps

Log out button options

Name Type Required Description
onClick () => void Yes Click handler

BarongResetPasswordForm

Reset password form

Name Type Required Description Default
redirection string Yes Redirection URL after successful submit.
host string Yes Barong host string. Example: https://foo-exchange.com/api/v2.
testMode boolean No If test mode is true, the submit is fired without calling the barong API.
tokenParameterName string No Name of the query parameter for token. reset_password_token

BarongForgotPasswordForm

Reset password form

Name Type Required Description Default
host string Yes Barong host string. Example: https://foo-exchange.com/api/v2.
testMode boolean No If test mode is true, the submit is fired without calling the barong API.
delay number No Seconds passed the user can resend an email. 60

ConfirmEmailForm

Reset password form

Name Type Required Description Default
host string Yes Barong host string. Example: https://foo-exchange.com/api/v2.
testMode boolean No If test mode is true, the submit is fired without calling the barong API.
tokenParameterName string No Name of the query parameter for token. token
pendingContent React.ReactNode No Pending content. Pending confirmation...
successContent React.ReactNode No Success content. Your email is confirmed.
errorContent React.ReactNode No Error content. Confirmation error.

Demo

If you want to see demo of this application:

  1. Clone repositroy
  2. Run
npm install
npm build
  1. Go to ./example directory and start development server:
npm install
npm start

Local development

For local development you can change version of react-barong inside ./example/package.json for

"react-barong": "link:.."

then, in root folder, run

npm install
npm start

and start development server

cd ./example
npm install
npm start

License

Apache 2.0 © openware

react-barong's People

Contributors

berezh avatar dependabot[bot] avatar kohelbekker avatar mod avatar

Stargazers

avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar

Forkers

dt021 rubi022 openware-mirror adrocks intelyshoen guangminglion dmt-space tesserakt-labs dezzyboy

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.