Properties for the CognitoLogin component.

Has callback events for onLoggedIn and onRegisteredUser.

Customize using buttonProps, loginButtonProps etc.

Children can be supplied to the forms: registerChildren, confirmChildren, forgotChildren, loginChildren

### Hierarchy

- ICognitoLoginProps

## Index

### Properties

- buttonProps
- cancelButtonProps
- confirmChildren
- emailInputProps
- forgotChildren
- loginButtonProps
- loginChildren
- onLoggedIn
- onRegisteredUser
- passwordInputProps
- phoneInputProps
- registerButtonProps
- registerChildren
- saveButtonProps

## Properties

### Optional buttonProps

buttonProps: ICrossButtonProps | undefined

- Defined in cognito-login/components/ICognitoLoginProps.tsx:36

Optional props to customize all buttons. Typically used to change the `mode` prop.

Read more: https://crossplatformsweden.github.io/react-native-components/interfaces/_components_buttons_crossbutton_.icrossbuttonprops.html

example

  <CognitoLogin buttonProps={{mode: 'contained'}}> <Text>Custom layouts here</Text> </CognitoLogin>

### Optional cancelButtonProps

cancelButtonProps: ICrossButtonProps | undefined

- Defined in cognito-login/components/ICognitoLoginProps.tsx:60

Optional props for the cancel button. Typically used to change the `title` prop.

Read more: https://crossplatformsweden.github.io/react-native-components/interfaces/_components_buttons_crossbutton_.icrossbuttonprops.html

example

  <CognitoLogin cancelButtonProps={{title: 'Disengage'}}> <Text>Custom layouts here</Text> </CognitoLogin>

### Optional confirmChildren

confirmChildren: ReactNode

- Defined in cognito-login/components/ICognitoLoginProps.tsx:115

Optional child components for the ConfirmForm

### Optional emailInputProps

emailInputProps: ICrossEditorProps | undefined

- Defined in cognito-login/components/ICognitoLoginProps.tsx:94

Optional props for the e-mail input. Typically used to change the `label` prop. See {@link ICrossEditorProps}

### Optional forgotChildren

forgotChildren: ReactNode

- Defined in cognito-login/components/ICognitoLoginProps.tsx:103

Optional child components for the ForgotForm (reset password)

### Optional loginButtonProps

loginButtonProps: ICrossButtonProps | undefined

- Defined in cognito-login/components/ICognitoLoginProps.tsx:48

Optional props for the login button. Typically used to change the `title` prop.

Read more: https://crossplatformsweden.github.io/react-native-components/interfaces/_components_buttons_crossbutton_.icrossbuttonprops.html

example

  <CognitoLogin loginButtonProps={{title: 'Engage'}}> <Text>Custom layouts here</Text> </CognitoLogin>

### Optional loginChildren

loginChildren: ReactNode

- Defined in cognito-login/components/ICognitoLoginProps.tsx:107

Optional child components for the LoginForm (username / password)

### Optional onLoggedIn

onLoggedIn: undefined | function

- Defined in cognito-login/components/ICognitoLoginProps.tsx:18

Occurs when the user was successfully logged in and contains the resulting user.

### Optional onRegisteredUser

onRegisteredUser: undefined | function

- Defined in cognito-login/components/ICognitoLoginProps.tsx:23

Occurs when the user was succcessfully registered and carries the user object.

### Optional passwordInputProps

passwordInputProps: ICrossEditorProps | undefined

- Defined in cognito-login/components/ICognitoLoginProps.tsx:99

Optional props for the password input. Typically used to change the `label` prop. See {@link ICrossEditorProps}

### Optional phoneInputProps

phoneInputProps: ICrossEditorProps | undefined

- Defined in cognito-login/components/ICognitoLoginProps.tsx:89

Optional props for the phone input. Typically used to change the `label` prop or change the `maskProps`. See {@link ICrossEditorProps}

### Optional registerButtonProps

registerButtonProps: ICrossButtonProps | undefined

- Defined in cognito-login/components/ICognitoLoginProps.tsx:84

Optional props for the register button. Typically used to change the `title` prop.

Read more: https://crossplatformsweden.github.io/react-native-components/interfaces/_components_buttons_crossbutton_.icrossbuttonprops.html

example

  <CognitoLogin registerButtonProps={{title: 'Enlist'}}> <Text>Custom layouts here</Text> </CognitoLogin>

### Optional registerChildren

registerChildren: ReactNode

- Defined in cognito-login/components/ICognitoLoginProps.tsx:111

Optional child components for the RegisterForm

### Optional saveButtonProps

saveButtonProps: ICrossButtonProps | undefined

- Defined in cognito-login/components/ICognitoLoginProps.tsx:72

Optional props for the save button. Typically used to change the `title` prop.

Read more: https://crossplatformsweden.github.io/react-native-components/interfaces/_components_buttons_crossbutton_.icrossbuttonprops.html

example

  <CognitoLogin saveButtonProps={{title: 'Warp'}}> <Text>Custom layouts here</Text> </CognitoLogin>