Home Manual Reference Source Test Repository

Variable

Static Public Summary
public

Action: {"configure": *, "authenticated": *, "loggingIn": *, "login": *, "logout": *, "loginFailure": *, "mfaRequired": *, "newPasswordRequired": *, "newPasswordRequiredFailure": *, "emailVerificationRequired": *, "emailVerificationFailed": *, "beginPasswordResetFlow": *, "finishPasswordResetFlow": *, "updateAttributes": *, "confirmationRequired": *}

container for all the actions
public

CognitoState: {"LOGGED_OUT": string, "AUTHENTICATED": string, "LOGGING_IN": string, "LOGGED_IN": string, "NEW_PASSWORD_REQUIRED": string, "MFA_REQUIRED": string, "EMAIL_VERIFICATION_REQUIRED": string, "CONFIRMATION_REQUIRED": string}

states stored in store.cognito.state
public

Confirm: *

Container for a confirmation form.
public

Wrapper for an Email Verification Form.
public

Login: *

Container for login behaviour, wrapping a login form.
public

Wrapper for a New Password Required form
public

Container for a Password Reset form

Static Public

public Action: {"configure": *, "authenticated": *, "loggingIn": *, "login": *, "logout": *, "loginFailure": *, "mfaRequired": *, "newPasswordRequired": *, "newPasswordRequiredFailure": *, "emailVerificationRequired": *, "emailVerificationFailed": *, "beginPasswordResetFlow": *, "finishPasswordResetFlow": *, "updateAttributes": *, "confirmationRequired": *} source 

import {Action} from 'react-cognito/src/actions.js'

container for all the actions

public CognitoState: {"LOGGED_OUT": string, "AUTHENTICATED": string, "LOGGING_IN": string, "LOGGED_IN": string, "NEW_PASSWORD_REQUIRED": string, "MFA_REQUIRED": string, "EMAIL_VERIFICATION_REQUIRED": string, "CONFIRMATION_REQUIRED": string} source 

import {CognitoState} from 'react-cognito/src/states.js'

states stored in store.cognito.state

public Confirm: * source 

import {Confirm} from 'react-cognito/src/Confirm.jsx'

Container for a confirmation form. Magically adds the following props to the contained form:

  • user - the Cognito User from the redux store
  • error - the persisted error from the redux store
  • onSubmit - a handler that calls the Cognito confirm API
  • onResend - a handler that calls the Cognito resend request API
  • onCancel - Logs the user out completely

Example:

<Confirm>
  <ConfirmForm />
</Confirm>

public EmailVerification: * source 

import {EmailVerification} from 'react-cognito/src/EmailVerification.jsx'

Wrapper for an Email Verification Form. Magically adds the following props to the contained form:

  • user - the Cognito user from the Redux store
  • error - the persisted error from the Redux store
  • onSubmit - a handler that calls the Cognito verification API

Example:

<EmailVerification>
  <EmailVerificationForm />
</EmailVerification>

public Login: * source 

import {Login} from 'react-cognito/src/Login.jsx'

Container for login behaviour, wrapping a login form.

Magically provides the following props to the wrapped form:

  • username
  • error
  • onSubmit

Example:

<Login>
  <LoginForm />
</Login>

public NewPasswordRequired: * source 

import {NewPasswordRequired} from 'react-cognito/src/NewPasswordRequired.jsx'

Wrapper for a New Password Required form

Magically provides the following props to the wrapped element:

  • user - the Cognito user
  • error - the persistent react-cognito error message
  • onSubmit - a handler that calls the Set New Password API

Example:


<NewPasswordRequired>
  <NewPasswordRequiredForm />
</NewPasswordRequired>

public PasswordReset: * source 

import {PasswordReset} from 'react-cognito/src/PasswordReset.jsx'

Container for a Password Reset form

Magically provides the following props to the wrapped element:

  • user
  • username
  • error
  • sendVerificationCode
  • setPassword

Example:

<PasswordReset>
  <PasswordResetForm />
</PasswordReset>