chore(docs): add headless auth usage page #3045
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
joebuono
reviewed
Nov 22, 2022
...ges/[platform]/connected-components/authenticator/headless/advanced/example.react-native.mdx
Outdated
Show resolved
Hide resolved
Comment on lines
29
to
53
| ### Authentication Check | ||
|
|
||
| If you just need to check if you're authenticated or not, you can use the more straightforward `useAuthenticator` hook to access the `authStatus` string. The `authStatus` string can represent the following states: | ||
|
|
||
| - `configuring` | ||
| - `authenticated` | ||
| - `unauthenticated` | ||
|
|
||
| > The `configuring` state only occurs when the `Authenticator` is first loading. | ||
|
|
||
| ```tsx{1,4-7} | ||
| import { useAuthenticator } from '@aws-amplify/ui-react-native'; | ||
|
|
||
| const App = () => { | ||
| const { authStatus } = useAuthenticator(context => [context.authStatus]); | ||
|
|
||
| // Use the value of authStatus to decide which page to render | ||
| return ( | ||
| <> | ||
| {authStatus === 'configuring' && 'Loading...'} | ||
| {authStatus !== 'authenticated' ? <Authenticator /> : <Home />} | ||
| </> | ||
| ); | ||
| }; | ||
| ``` |
There was a problem hiding this comment.
Let's remove this. I'm not entirely sure that authStatus works as expected
| const Home = () => { | ||
| const { user, signOut } = useAuthenticator((context) => [context.user]); | ||
|
|
||
| return <button onClick={signOut}>Welcome, {user.username}!</button>; |
There was a problem hiding this comment.
Suggested change
| return <button onClick={signOut}>Welcome, {user.username}!</button>; | |
| return <Button onPress={signOut} title={`Welcome, ${user.username}!`} />; |
| You can use `useAuthenticator` hook to access functions that lets you trigger transitions to the authenticator. Please see [Full API](#full-api) to see all supported transition functions. Any invalid transitions (e.g. `signUp` directly to `authenticated`) will be ignored. | ||
|
|
||
| ```tsx{1,4-6} | ||
| import { useAuthenticator } from '@aws-amplify/ui-react-native'; |
There was a problem hiding this comment.
Suggested change
| import { useAuthenticator } from '@aws-amplify/ui-react-native'; | |
| import { Button } from 'react-native'; | |
| import { useAuthenticator } from '@aws-amplify/ui-react-native'; |
Comment on lines
33
to
34
| import { Authenticator } from '@aws-amplify/ui-react-native'; | ||
| import { View } from 'react-native'; |
There was a problem hiding this comment.
Not sure if this how all our docs are but generally think it's beet to place React and React Native imports above ours:
Suggested change
| import { Authenticator } from '@aws-amplify/ui-react-native'; | |
| import { View } from 'react-native'; | |
| import { Text, View } from 'react-native'; | |
| import { Authenticator } from '@aws-amplify/ui-react-native'; |
| export default function App() { | ||
| return ( | ||
| <Authenticator.Provider> | ||
| <View>Your app here</View> |
There was a problem hiding this comment.
React Native can only render strings within a Text component:
Suggested change
| <View>Your app here</View> | |
| <View> | |
| <Text>Your app here</Text> | |
| </View> |
| @@ -0,0 +1,16 @@ | |||
| You can use `useAuthenticator` hook to access current signed in `user`. If no user is authenticated, it'll return `undefined`. | |||
|
|
|||
| ```tsx{1,4,8-9} | |||
There was a problem hiding this comment.
Are we sure we need the line highlights?
Comment on lines
9
to
35
| export default function App() { | ||
| const components = { | ||
| SignIn: { | ||
| Footer() { | ||
| const { toResetPassword } = useAuthenticator(); | ||
| return ( | ||
| <View> | ||
| <Button onPress={toResetPassword}> | ||
| Custom Reset Password | ||
| </Button> | ||
| </View> | ||
| ); | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| return ( | ||
| <Authenticator components={components}> | ||
| {({ signOut, user }) => ( | ||
| <View> | ||
| <Text>Hello {user.username}</Text> | ||
| <Button onPress={signOut}>Sign out</Button> | ||
| </View> | ||
| )} | ||
| </Authenticator> | ||
| ); | ||
| } |
There was a problem hiding this comment.
The components prop does not behave the same between React and React Native:
Suggested change
| export default function App() { | |
| const components = { | |
| SignIn: { | |
| Footer() { | |
| const { toResetPassword } = useAuthenticator(); | |
| return ( | |
| <View> | |
| <Button onPress={toResetPassword}> | |
| Custom Reset Password | |
| </Button> | |
| </View> | |
| ); | |
| }, | |
| }, | |
| }; | |
| return ( | |
| <Authenticator components={components}> | |
| {({ signOut, user }) => ( | |
| <View> | |
| <Text>Hello {user.username}</Text> | |
| <Button onPress={signOut}>Sign out</Button> | |
| </View> | |
| )} | |
| </Authenticator> | |
| ); | |
| } | |
| function Footer() { | |
| const { toResetPassword } = useAuthenticator(); | |
| return ( | |
| <Button onPress={toResetPassword} title="Custom Reset Password" /> | |
| ); | |
| }, | |
| export default function App() { | |
| return ( | |
| <Authenticator components={{ | |
| SignIn: (props) => <Authenticator.SignIn {...props} Footer={Footer} /> | |
| }}> | |
| <View> | |
| <Text>Hello {user.username}</Text> | |
| <Button onPress={signOut} title="Sign out" /> | |
| </View> | |
| </Authenticator> | |
| ); | |
| } |
|
|
||
| Then, you can use `useAuthenticator` on your App: | ||
|
|
||
| ```tsx |
There was a problem hiding this comment.
Can we align all the examples as being jsx
calebpollman
approved these changes
Nov 22, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
Add headless auth usage page
Issue #, if available
Description of how you validated changes
Checklist
yarn testpassessideEffectsfield updatedBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.