1.0.1 • Published 5 years ago
@mihaben/react-twitter-auth v1.0.1
React Twitter Authentication Component
A React Twitter oAUth Sign-in / Log-in Component for React, implemented with Apollo
Installation
npm install mihaben/react-twitter-auth
Usage
<TwitterLogin
onFailure={this.onFailed}
onSuccess={this.onSuccess}
requestTokenQuery={REQUEST_TOKEN_QUERY}
/>Custom content that overrides default content:
<TwitterLogin
onFailure={this.onFailed}
onSuccess={this.onSuccess}
requestTokenQuery={REQUEST_TOKEN_QUERY}
showIcon={true}
>
<b>Custom</b> Twitter <i>Login</i> content
</TwitterLogin>Options
| params | value | default value | description |
|---|---|---|---|
| tag | string | button | tag that should be used to create element that will be used as loging element |
| text | string | Sign in with Twitter | text that will be shown in component |
| requestTokenQuery | function | gql (graphql-tag) query | |
| onFailure | function | function that will be called if user cannot be authenticated | |
| onSuccess | function | function that will be called with {oauthToken, oauthVerifier} | |
| disabled | boolean | false | disable component |
| style | object | style object | |
| className | string | class name for component | |
| dialogWidth | number | 600 | dialog width |
| dialogHeight | number | 400 | dialog height |
| showIcon | bool | true | should default icon be visible |
| children | node | this props can be used in order to override default component content | |
| forceLogin | bool | false | force user to authenticate with Twitter username and password |
| screenName | string | prefills the username input box of the OAuth login screen with the given value |
License
react-twitter-auth is released under MIT License.