Skip to content

Commit d0b8b99

Browse files
committed
update docs
1 parent c4380cb commit d0b8b99

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,34 +11,35 @@
1111

1212
```jsx harmony
1313
<SlackLogin
14-
redirectUrl="http://localhost:4000/api/v1/auth/slack"
14+
redirectUrl='http://localhost:4000/api/v1/auth/slack'
1515
onFailure={onFailed}
1616
onSuccess={onSuccess}
17-
slackClientId="SLACK_CLIENT_ID"
18-
slackUserScope = 'identity.basic'
17+
slackClientId='SLACK_CLIENT_ID'
18+
slackUserScope='identity.basic'
1919
/>
2020
```
2121

2222
## Options
2323

24-
| params | value | default value | description |
25-
| :-------------: | :------: | :------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
26-
| redirectUrl | string | | The URL the user should return to once Slack has validated their approval |
27-
| slackClientId | string | | Slack Client Id |
28-
| slackUserScope| string | | A comma- or space-separated list of permissions you're requesting the user to approve. If you're just logging users in, set this to identity.basic. You can't ask for identity.email, identity.team, or identity.avatar without also asking for identity.basic |
29-
| onFailure | function | | function that will be called if user cannot be authenticated |
30-
| onSuccess | function | | function that will be called if user is successfully authenticated |
24+
| params | value | default value | description |
25+
| :------------: | :------: | :-----------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
26+
| redirectUrl | string | | The URL the user should return to once Slack has validated their approval |
27+
| slackClientId | string | | Slack Client Id |
28+
| slackUserScope | string | | A comma- or space-separated list of permissions you're requesting the user to approve. If you're just logging users in, set this to identity.basic. You can't ask for identity.email, identity.team, or identity.avatar without also asking for identity.basic |
29+
| onFailure | function | | function that will be called if user cannot be authenticated |
30+
| onSuccess | function | | function that will be called if user is successfully authenticated |
3131

3232
# Workflow
3333

34-
The component will return a slack OAuth verifier code, you should send that code to your API and exchange your temporary OAuth verifier code for an access token.
34+
The component will return a slack OAuth verifier code, you should send that code to your API and exchange your temporary OAuth verifier code for an access token.
3535

3636
> This exchange can't be part of a frontend app because requires your SLACK_CLIENT_SECRET and this value should not be exposed.
3737
3838
See:
39+
3940
- https://api.slack.com/methods/oauth.v2.access
4041
- [Legacy Apps] https://api.slack.com/methods/oauth.access
4142

4243
# License
4344

44-
react-slack-login is released under [MIT License](https://opensource.org/licenses/MIT).
45+
react-slack-login is released under [MIT License](https://opensource.org/licenses/MIT).

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-slack-login",
3-
"version": "1.1.3",
3+
"version": "1.1.4",
44
"description": "A React Component for Slack Login",
55
"main": "dist/react-slack-login.js",
66
"scripts": {

0 commit comments

Comments
 (0)