Skip to content

Commit

Permalink
feat(docs): add custom labels to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
akiokio committed Aug 24, 2018
1 parent 37e31aa commit 5b64d3f
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Check out the [examples](https://akiokio.github.io/ReactSignupLoginComponent/) t
- Callbacks for every action
- 100% test coverage
- Drop-in component
- Custom labels for any text: replace any text to your own nice for customization or internationalization

## How to use it

Expand Down Expand Up @@ -143,6 +144,21 @@ You can overhide the component style passing an object to the styles prop. Here'
/>
```

### Custom labels
Here's the list of possible custom labels you can use:
```
usernameCustomLabel="Anything you want"
passwordCustomLabel="Anything you want"
passwordConfirmationCustomLabel="Anything you want"
recoverPasswordCustomLabel="Anything you want"
signupCustomLabel="Anything you want"
submitLoginCustomLabel="Anything you want"
goToLoginCustomLabel="Anything you want"
submitSignupCustomLabel="Anything you want"
goToSignupCustomLabel="Anything you want"
submitRecoverPasswordCustomLabel="Anything you want"
```

## Tests
We have a 100% percent test coverage, to run the tests locally:
```js
Expand Down

0 comments on commit 5b64d3f

Please sign in to comment.