Amplify UI Home

Headless

For advanced use cases you can run the Authenticator in a headless mode.

Access Auth State

Access Authenticated User

Trigger Transitions

Example

Here's an example that uses the toResetPassword trigger transition, to create a custom button. Note that example uses the Footer "slot" override.

Full API

These are readonly contexts that represent the current auth state. Any unapplicable context will be undefined.

Name Description Type
user Current signed in user AmplifyUser
route Name of the auth flow user is in string
error Any error returned from service API call string
validationErrors Any form validation errors found. Maps each error message to respective input name. Record<string, string>
hasValidationErrors Whether there are any form validation errors boolean
isPending Whether service API call is in progress boolean
codeDeliveryDetail Provides detail on where confirm sign up code is sent to. CodeDeliveryDetail

Amplify open source software, documentation and community are supported by Amazon Web Services.

© 2022 Amazon Web Services, Inc. and its affiliates. All rights reserved. View the site terms and privacy policy.

Flutter and the related logo are trademarks of Google LLC. We are not endorsed by or affiliated with Google LLC.