---
title: supertokens-auth-react/types
description: References documentation for the supertokens-auth-react/types package
sidebar:
  order: 20
---

## Type Aliases

### AllRecipeComponentOverrides

```ts check=false reason="Generated API signature"
type AllRecipeComponentOverrides = object;
```

Defined in: [types.ts:509](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L509)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="authrecipe"></a> `authRecipe` | `AuthRecipeComponentOverrideMap` | [types.ts:519](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L519) |
| <a id="emailpassword"></a> `emailpassword` | [`ComponentOverrideMap`](recipe-emailpassword-types#componentoverridemap) | [types.ts:510](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L510) |
| <a id="emailverification"></a> `emailverification` | [`ComponentOverrideMap`](recipe-emailverification-types#componentoverridemap) | [types.ts:511](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L511) |
| <a id="multifactorauth"></a> `multifactorauth` | [`ComponentOverrideMap`](recipe-multifactorauth-types#componentoverridemap) | [types.ts:512](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L512) |
| <a id="multitenancy"></a> `multitenancy` | [`ComponentOverrideMap`](recipe-multitenancy-types#componentoverridemap) | [types.ts:513](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L513) |
| <a id="oauth2provider"></a> `oauth2provider` | [`ComponentOverrideMap`](recipe-oauth2provider-types#componentoverridemap) | [types.ts:514](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L514) |
| <a id="passwordless"></a> `passwordless` | [`ComponentOverrideMap`](recipe-passwordless-types#componentoverridemap) | [types.ts:515](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L515) |
| <a id="session"></a> `session` | [`ComponentOverrideMap`](recipe-session-types#componentoverridemap) | [types.ts:516](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L516) |
| <a id="thirdparty"></a> `thirdparty` | [`ComponentOverrideMap`](recipe-thirdparty-types#componentoverridemap) | [types.ts:517](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L517) |
| <a id="totp"></a> `totp` | [`ComponentOverrideMap`](recipe-totp-types#componentoverridemap) | [types.ts:518](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L518) |
| <a id="webauthn"></a> `webauthn` | [`ComponentOverrideMap`](recipe-webauthn-types#componentoverridemap) | [types.ts:520](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L520) |

***

### AllRecipeConfigs

```ts check=false reason="Generated API signature"
type AllRecipeConfigs = object;
```

Defined in: [types.ts:496](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L496)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emailpassword-1"></a> `emailpassword` | [`Config`](recipe-emailpassword-types#config) | [types.ts:497](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L497) |
| <a id="emailverification-1"></a> `emailverification` | [`Config`](recipe-emailverification-types#config) | [types.ts:498](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L498) |
| <a id="multifactorauth-1"></a> `multifactorauth` | [`Config`](recipe-multifactorauth-types#config) | [types.ts:499](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L499) |
| <a id="multitenancy-1"></a> `multitenancy` | [`UserInput`](recipe-multitenancy-types#userinput) | [types.ts:500](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L500) |
| <a id="oauth2provider-1"></a> `oauth2provider` | [`UserInput`](recipe-oauth2provider-types#userinput) | [types.ts:501](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L501) |
| <a id="passwordless-1"></a> `passwordless` | [`Config`](recipe-passwordless-types#config) | [types.ts:502](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L502) |
| <a id="session-1"></a> `session` | [`InputType`](recipe-session-types#inputtype) | [types.ts:503](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L503) |
| <a id="thirdparty-1"></a> `thirdparty` | [`Config`](recipe-thirdparty-types#config) | [types.ts:504](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L504) |
| <a id="totp-1"></a> `totp` | [`Config`](recipe-totp-types#config) | [types.ts:505](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L505) |
| <a id="webauthn-1"></a> `webauthn` | [`Config`](recipe-webauthn-types#config) | [types.ts:506](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L506) |

***

### APIFormField

```ts check=false reason="Generated API signature"
type APIFormField = object;
```

Defined in: [types.ts:340](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L340)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="id"></a> `id` | `string` | [types.ts:344](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L344) |
| <a id="value"></a> `value` | `string` | [types.ts:349](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L349) |

***

### AppInfoUserInput

```ts check=false reason="Generated API signature"
type AppInfoUserInput = object;
```

Defined in: [types.ts:202](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L202)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="apibasepath"></a> `apiBasePath?` | `string` | - | [types.ts:222](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L222) |
| <a id="apidomain"></a> `apiDomain` | `string` | - | [types.ts:211](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L211) |
| <a id="apigatewaypath"></a> `apiGatewayPath?` | `string` | An API gateway may be used which prepends a path to the API route. That path should be specified here. | [types.ts:234](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L234) |
| <a id="appname"></a> `appName` | `string` | - | [types.ts:206](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L206) |
| <a id="websitebasepath"></a> `websiteBasePath?` | `string` | - | [types.ts:228](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L228) |
| <a id="websitedomain"></a> `websiteDomain` | `string` | - | [types.ts:216](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L216) |

***

### AuthComponent\<T\>

```ts check=false reason="Generated API signature"
type AuthComponent<T> = 
  | PartialAuthComponent
| FullPageAuthComponent<T>;
```

Defined in: [types.ts:491](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L491)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` | `any` |

***

### AuthComponentProps

```ts check=false reason="Generated API signature"
type AuthComponentProps = object;
```

Defined in: [types.ts:457](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L457)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="children"></a> `children?` | `React.ReactNode` | [types.ts:469](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L469) |
| <a id="clearerror"></a> `clearError` | () => `void` | [types.ts:467](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L467) |
| <a id="error"></a> `error` | `string` \| `undefined` | [types.ts:465](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L465) |
| <a id="member-authcomponentprops-navigate"></a> `navigate` | [`Navigate`](#navigate) \| `undefined` | [types.ts:463](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L463) |
| <a id="onauthsuccess"></a> `onAuthSuccess` | (`successContext`) => `Promise`\<`void`\> | [types.ts:462](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L462) |
| <a id="onerror"></a> `onError` | (`err`) => `void` | [types.ts:466](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L466) |
| <a id="onsigninupswitcherclick"></a> `onSignInUpSwitcherClick` | () => `void` | [types.ts:460](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L460) |
| <a id="rebuildauthpage"></a> `rebuildAuthPage` | () => `void` | [types.ts:461](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L461) |
| <a id="resetfactorlist"></a> `resetFactorList` | () => `void` | [types.ts:459](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L459) |
| <a id="setfactorlist"></a> `setFactorList` | (`factorIds`) => `void` | [types.ts:458](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L458) |
| <a id="showbackbutton"></a> `showBackButton` | `boolean` | [types.ts:468](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L468) |
| <a id="member-authcomponentprops-usercontext"></a> `userContext` | [`UserContext`](#usercontext) | [types.ts:464](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L464) |

***

### Awaited\<T\>

```ts check=false reason="Generated API signature"
type Awaited<T> = T extends null | undefined ? T : T extends object & object ? F extends (value, ...args) => any ? V : never : T;
```

Defined in: [types.ts:432](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L432)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

***

### BaseFeatureComponentMap

```ts check=false reason="Generated API signature"
type BaseFeatureComponentMap = Record<string, ComponentWithRecipeAndMatchingMethod[]>;
```

Defined in: [types.ts:299](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L299)

***

### ComponentWithRecipeAndMatchingMethod

```ts check=false reason="Generated API signature"
type ComponentWithRecipeAndMatchingMethod = object;
```

Defined in: [types.ts:280](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L280)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="component"></a> `component` | [`ReactComponentClass`](#reactcomponentclass) | - | [types.ts:284](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L284) |
| <a id="matches"></a> `matches` | () => `boolean` | - | [types.ts:289](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L289) |
| <a id="recipeid"></a> `recipeID` | `string` | Recipe ID this component belongs | [types.ts:294](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L294) |

***

### CreateRecipeFunction()\<T, S, R, N\>

```ts check=false reason="Generated API signature"
type CreateRecipeFunction<T, S, R, N> = (appInfo, enableDebugLogs) => BaseRecipeModule<T, S, R, N>;
```

Defined in: [types.ts:197](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L197)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |
| `S` |
| `R` |
| `N` *extends* `NormalisedRecipeModuleConfig`\<`T`, `S`, `R`\> |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](#normalisedappinfo) |
| `enableDebugLogs` | `boolean` |

#### Returns

`BaseRecipeModule`\<`T`, `S`, `R`, `N`\>

***

### FeatureBaseConfig

```ts check=false reason="Generated API signature"
type FeatureBaseConfig = object;
```

Defined in: [types.ts:407](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L407)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="style"></a> `style?` | `string` | [types.ts:411](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L411) |

***

### FeatureBaseProps\<T\>

```ts check=false reason="Generated API signature"
type FeatureBaseProps<T> = PropsWithChildren<object & T>;
```

Defined in: [types.ts:425](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L425)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` | `Record`\<`string`, `unknown`\> |

***

### FormField

```ts check=false reason="Generated API signature"
type FormField = FormFieldBaseConfig & object;
```

Defined in: [types.ts:328](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L328)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `optional?` | `boolean` | [types.ts:337](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L337) |
| `validate()?` | (`value`) => `Promise`\<`string` \| `undefined`\> | [types.ts:332](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L332) |

***

### FormFieldBaseConfig

```ts check=false reason="Generated API signature"
type FormFieldBaseConfig = object;
```

Defined in: [types.ts:301](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L301)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getdefaultvalue"></a> `getDefaultValue?` | () => `string` | [types.ts:320](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L320) |
| <a id="id-1"></a> `id` | `string` | [types.ts:305](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L305) |
| <a id="label"></a> `label` | `string` | [types.ts:310](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L310) |
| <a id="nonoptionalerrormsg"></a> `nonOptionalErrorMsg?` | `string` | [types.ts:325](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L325) |
| <a id="placeholder"></a> `placeholder?` | `string` | [types.ts:315](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L315) |

***

### FullPageAuthComponent\<PreloadInfoType\>

```ts check=false reason="Generated API signature"
type FullPageAuthComponent<PreloadInfoType> = object;
```

Defined in: [types.ts:474](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L474)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `PreloadInfoType` | `any` |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="component-1"></a> `component` | `React.FC`\<[`FullPageAuthComponentProps`](#fullpageauthcomponentprops)\<`PreloadInfoType`\>\> | [types.ts:481](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L481) |
| <a id="preloadinfoandrunchecks"></a> `preloadInfoAndRunChecks` | (`firstFactors`, `userContext`, `isSignUp`) => `Promise`\< \| \{ `preloadInfo`: `PreloadInfoType`; `shouldDisplay`: `true`; \} \| \{ `shouldDisplay`: `false`; \}\> | [types.ts:476](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L476) |
| <a id="type"></a> `type` | `"FULL_PAGE"` | [types.ts:475](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L475) |

***

### FullPageAuthComponentProps\<PreloadInfoType\>

```ts check=false reason="Generated API signature"
type FullPageAuthComponentProps<PreloadInfoType> = AuthComponentProps & object;
```

Defined in: [types.ts:472](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L472)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `preloadInfo` | `PreloadInfoType` | [types.ts:472](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L472) |

#### Type Parameters

| Type Parameter |
| ------ |
| `PreloadInfoType` |

***

### GetRedirectionURLContext

```ts check=false reason="Generated API signature"
type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<
  | {
  action: "TO_AUTH";
  showSignIn?: boolean;
}
| SuccessRedirectContextInApp>;
```

Defined in: [types.ts:72](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L72)

***

### Navigate

```ts check=false reason="Generated API signature"
type Navigate = 
  | {
  goBack: () => void;
  push: (path) => void;
}
  | NavigateFunction;
```

Defined in: [types.ts:448](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L448)

***

### NonPublicConfigPropertiesType

```ts check=false reason="Generated API signature"
type NonPublicConfigPropertiesType = typeof nonPublicConfigProperties[number];
```

Defined in: [types.ts:566](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L566)

***

### NormalisedAppInfo

```ts check=false reason="Generated API signature"
type NormalisedAppInfo = object;
```

Defined in: [types.ts:248](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L248)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="apibasepath-1"></a> `apiBasePath` | [`SuperTokensWrapper`](index#supertokenswrapper-1) | [types.ts:268](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L268) |
| <a id="apidomain-1"></a> `apiDomain` | [`SuperTokensWrapper`](index#supertokenswrapper-1) | [types.ts:257](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L257) |
| <a id="appname-1"></a> `appName` | `string` | [types.ts:252](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L252) |
| <a id="websitebasepath-1"></a> `websiteBasePath` | [`SuperTokensWrapper`](index#supertokenswrapper-1) | [types.ts:274](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L274) |
| <a id="websitedomain-1"></a> `websiteDomain` | [`SuperTokensWrapper`](index#supertokenswrapper-1) | [types.ts:262](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L262) |

***

### NormalisedBaseConfig

```ts check=false reason="Generated API signature"
type NormalisedBaseConfig = object;
```

Defined in: [types.ts:414](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L414)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="style-1"></a> `style` | `string` | [types.ts:418](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L418) |

***

### NormalisedConfigWithAppInfoAndRecipeID\<NormalisedConfig\>

```ts check=false reason="Generated API signature"
type NormalisedConfigWithAppInfoAndRecipeID<NormalisedConfig> = NormalisedConfig & object;
```

Defined in: [types.ts:243](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L243)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](#normalisedappinfo) | [types.ts:244](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L244) |
| `recipeId` | `string` | [types.ts:245](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L245) |

#### Type Parameters

| Type Parameter |
| ------ |
| `NormalisedConfig` |

***

### NormalisedFormField

```ts check=false reason="Generated API signature"
type NormalisedFormField = object;
```

Defined in: [types.ts:352](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L352)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="autocomplete"></a> `autoComplete?` | `string` | [types.ts:386](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L386) |
| <a id="autofocus"></a> `autofocus?` | `boolean` | [types.ts:391](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L391) |
| <a id="getdefaultvalue-1"></a> `getDefaultValue?` | () => `string` | [types.ts:396](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L396) |
| <a id="hidden"></a> `hidden?` | `boolean` | [types.ts:398](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L398) |
| <a id="id-2"></a> `id` | `string` | [types.ts:356](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L356) |
| <a id="label-1"></a> `label` | `string` | [types.ts:361](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L361) |
| <a id="nonoptionalerrormsg-1"></a> `nonOptionalErrorMsg?` | `string` | [types.ts:381](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L381) |
| <a id="optional"></a> `optional` | `boolean` | [types.ts:376](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L376) |
| <a id="placeholder-1"></a> `placeholder` | `string` | [types.ts:366](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L366) |
| <a id="validate"></a> `validate` | (`value`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | [types.ts:371](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L371) |

***

### NormalisedGetRedirectionURLContext\<RecipeContext\>

```ts check=false reason="Generated API signature"
type NormalisedGetRedirectionURLContext<RecipeContext> = RecipeContext & object;
```

Defined in: [types.ts:492](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L492)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `tenantIdFromQueryParams` | `string` \| `undefined` | [types.ts:493](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L493) |

#### Type Parameters

| Type Parameter |
| ------ |
| `RecipeContext` |

***

### PartialAuthComponent

```ts check=false reason="Generated API signature"
type PartialAuthComponent = object;
```

Defined in: [types.ts:484](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L484)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="component-2"></a> `component` | `React.FC`\<[`PartialAuthComponentProps`](#partialauthcomponentprops)\> | [types.ts:488](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L488) |
| <a id="displayorder"></a> `displayOrder` | `number` | [types.ts:487](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L487) |
| <a id="factorids"></a> `factorIds` | `string`[] | [types.ts:486](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L486) |
| <a id="type-1"></a> `type` | `"SIGN_IN_UP"` \| `"SIGN_IN"` \| `"SIGN_UP"` | [types.ts:485](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L485) |

***

### PartialAuthComponentProps

```ts check=false reason="Generated API signature"
type PartialAuthComponentProps = AuthComponentProps;
```

Defined in: [types.ts:471](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L471)

***

### PluginRouteHandler

```ts check=false reason="Generated API signature"
type PluginRouteHandler = object;
```

Defined in: [types.ts:529](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L529)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="handler"></a> `handler` | () => `JSX.Element` | [types.ts:531](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L531) |
| <a id="path"></a> `path` | `string` | [types.ts:530](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L530) |

***

### ReactComponentClass\<P\>

```ts check=false reason="Generated API signature"
type ReactComponentClass<P> = ComponentClass<P, any> | (props) => JSX.Element;
```

Defined in: [types.ts:401](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L401)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `P` | `any` |

***

### RecipeFeatureComponentMap

```ts check=false reason="Generated API signature"
type RecipeFeatureComponentMap = Record<string, ComponentWithRecipeAndMatchingMethod>;
```

Defined in: [types.ts:297](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L297)

***

### RecipeInitResult\<T, Action, R, P\>

```ts check=false reason="Generated API signature"
type RecipeInitResult<T, Action, R, P> = object;
```

Defined in: [types.ts:237](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L237)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |
| `Action` |
| `R` |
| `P` *extends* `NormalisedRecipeModuleConfig`\<`T`, `Action`, `R`\> |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="authreact"></a> `authReact` | [`CreateRecipeFunction`](#createrecipefunction)\<`T`, `Action`, `R`, `P`\> | [types.ts:239](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L239) |
| <a id="recipeid-1"></a> `recipeID` | `string` | [types.ts:238](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L238) |
| <a id="webjs"></a> `webJS` | [`SuperTokensWrapper`](index#supertokenswrapper-1)\<`Action`\> | [types.ts:240](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L240) |

***

### RecipePluginOverride\<T\>

```ts check=false reason="Generated API signature"
type RecipePluginOverride<T> = object;
```

Defined in: [types.ts:523](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L523)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* keyof [`AllRecipeConfigs`](#allrecipeconfigs) |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="components"></a> `components?` | [`AllRecipeComponentOverrides`](#allrecipecomponentoverrides)\[`T`\] | [types.ts:525](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L525) |
| <a id="config"></a> `config?` | (`config`) => [`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\] | [types.ts:526](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L526) |
| <a id="functions"></a> `functions?` | `NonNullable`\<[`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\]\[`"override"`\]\>\[`"functions"`\] | [types.ts:524](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L524) |

***

### SessionClaimValidator

```ts check=false reason="Generated API signature"
type SessionClaimValidator = SuperTokensWrapper & object;
```

Defined in: [types.ts:90](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L90)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `onFailureRedirection?` | [`ValidationFailureCallback`](#validationfailurecallback) | [types.ts:92](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L92) |
| `showAccessDeniedOnFailure?` | `boolean` | [types.ts:91](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L91) |

***

### SuccessRedirectContext

```ts check=false reason="Generated API signature"
type SuccessRedirectContext = 
  | SuccessRedirectContextInApp
  | SuccessRedirectContextOAuth2;
```

Defined in: [types.ts:70](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L70)

***

### SuccessRedirectContextInApp

```ts check=false reason="Generated API signature"
type SuccessRedirectContextInApp = SuccessRedirectContextCommon & object;
```

Defined in: [types.ts:64](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L64)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `action` | `"SUCCESS"` | [types.ts:64](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L64) |
| `redirectToPath?` | `string` | [types.ts:64](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L64) |

***

### SuccessRedirectContextOAuth2

```ts check=false reason="Generated API signature"
type SuccessRedirectContextOAuth2 = SuccessRedirectContextCommon & object;
```

Defined in: [types.ts:65](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L65)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `action` | `"SUCCESS_OAUTH2"` | [types.ts:66](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L66) |
| `frontendRedirectTo` | `string` | [types.ts:67](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L67) |

***

### SuperTokensConfig

```ts check=false reason="Generated API signature"
type SuperTokensConfig = object;
```

Defined in: [types.ts:99](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L99)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="appinfo"></a> `appInfo` | [`AppInfoUserInput`](#appinfouserinput) | - | [types.ts:103](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L103) |
| <a id="clienttype"></a> `clientType?` | `string` | Identifier for the client, such as `web`, `ios`, etc. to be used with thirdparty, multitenancy recipes. | [types.ts:108](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L108) |
| <a id="cookiehandler"></a> `cookieHandler?` | [`SuperTokensWrapper`](index#supertokenswrapper-1) | - | [types.ts:119](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L119) |
| <a id="dateprovider"></a> `dateProvider?` | [`SuperTokensWrapper`](index#supertokenswrapper-1) | - | [types.ts:123](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L123) |
| <a id="defaulttosignup"></a> `defaultToSignUp?` | `boolean` | - | [types.ts:169](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L169) |
| <a id="disableauthroute"></a> `disableAuthRoute?` | `boolean` | - | [types.ts:164](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L164) |
| <a id="enabledebuglogs"></a> `enableDebugLogs?` | `boolean` | - | [types.ts:156](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L156) |
| <a id="experimental"></a> `experimental?` | `object` | Our experimental features are not yet stable and are subject to change. In practical terms, this means that their interface is subject to change without a major version update. They are also not tested as much as our "normal" features. If you want to use these features, or if you have any feedback please let us know at: https://supertokens.com/discord | [types.ts:190](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L190) |
| `experimental.plugins?` | [`SuperTokensPlugin`](#supertokensplugin)[] | - | [types.ts:191](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L191) |
| <a id="getredirectionurl"></a> `getRedirectionURL?` | (`context`, `userContext`) => `Promise`\<`string` \| `undefined` \| `null`\> | - | [types.ts:157](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L157) |
| <a id="languagetranslations"></a> `languageTranslations?` | `object` | - | [types.ts:127](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L127) |
| `languageTranslations.currentLanguageCookieScope?` | `string` | - | [types.ts:137](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L137) |
| `languageTranslations.defaultLanguage?` | `string` | - | [types.ts:131](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L131) |
| `languageTranslations.translationFunc?` | `TranslationFunc` | - | [types.ts:154](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L154) |
| `languageTranslations.translations?` | [`TranslationStore`](index#translationstore) | - | [types.ts:149](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L149) |
| <a id="privacypolicylink"></a> `privacyPolicyLink?` | `string` | - | [types.ts:174](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L174) |
| <a id="recipelist"></a> `recipeList` | `object`[] | - | [types.ts:113](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L113) |
| <a id="style-2"></a> `style?` | `string` | - | [types.ts:162](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L162) |
| <a id="termsofservicelink"></a> `termsOfServiceLink?` | `string` | - | [types.ts:179](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L179) |
| <a id="usesdynamicloginmethods"></a> `usesDynamicLoginMethods?` | `boolean` | - | [types.ts:125](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L125) |
| <a id="useshadowdom"></a> `useShadowDom?` | `boolean` | - | [types.ts:163](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L163) |
| <a id="windowhandler"></a> `windowHandler?` | [`SuperTokensWrapper`](index#supertokenswrapper-1) | - | [types.ts:121](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L121) |

***

### SuperTokensConfigWithNormalisedAppInfo

```ts check=false reason="Generated API signature"
type SuperTokensConfigWithNormalisedAppInfo = Omit<SuperTokensConfig, "appInfo"> & object;
```

Defined in: [types.ts:568](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L568)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](#normalisedappinfo) | [types.ts:569](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L569) |

***

### SuperTokensPlugin

```ts check=false reason="Generated API signature"
type SuperTokensPlugin = object;
```

Defined in: [types.ts:535](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L535)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="compatibleauthreactsdkversions"></a> `compatibleAuthReactSDKVersions?` | `string` \| `string`[] | [types.ts:538](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L538) |
| <a id="compatiblewebjssdkversions"></a> `compatibleWebJSSDKVersions?` | `string` \| `string`[] | [types.ts:539](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L539) |
| <a id="config-1"></a> `config?` | (`config`) => \| `Omit`\<[`SuperTokensPublicConfig`](#supertokenspublicconfig), `"appInfo"`\> \| `undefined` | [types.ts:560](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L560) |
| <a id="dependencies"></a> `dependencies?` | (`config`, `pluginsAbove`, `sdkVersion`) => \| \{ `pluginsToAdd?`: [`SuperTokensPlugin`](#supertokensplugin)[]; `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"ERROR"`; \} | [types.ts:541](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L541) |
| <a id="exports"></a> `exports?` | `Record`\<`string`, `any`\> | [types.ts:561](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L561) |
| <a id="generalauthrecipecomponentoverrides"></a> `generalAuthRecipeComponentOverrides?` | `AuthRecipeComponentOverrideMap` | [types.ts:551](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L551) |
| <a id="id-3"></a> `id` | `string` | [types.ts:536](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L536) |
| <a id="init"></a> `init?` | (`config`, `allPlugins`, `sdkVersion`) => `void` | [types.ts:540](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L540) |
| <a id="overridemap"></a> `overrideMap?` | \{ \[recipeId in keyof AllRecipeConfigs\]?: RecipePluginOverride\<recipeId\> & \{ recipeInitRequired?: boolean \| ((sdkVersion: string) =\> boolean) \} \} | [types.ts:546](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L546) |
| <a id="routehandlers"></a> `routeHandlers?` | \| (`config`, `allPlugins`, `sdkVersion`) => \| \{ `routeHandlers`: [`PluginRouteHandler`](#pluginroutehandler)[]; `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"ERROR"`; \} \| [`PluginRouteHandler`](#pluginroutehandler)[] | [types.ts:552](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L552) |
| <a id="version"></a> `version?` | `string` | [types.ts:537](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L537) |

***

### SuperTokensPublicConfig

```ts check=false reason="Generated API signature"
type SuperTokensPublicConfig = Omit<Omit<SuperTokensConfig, NonPublicConfigPropertiesType>, "appInfo"> & object;
```

Defined in: [types.ts:576](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L576)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](#normalisedappinfo) | [types.ts:577](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L577) |

***

### SuperTokensPublicPlugin

```ts check=false reason="Generated API signature"
type SuperTokensPublicPlugin = Pick<SuperTokensPlugin, 
  | "id"
  | "version"
  | "exports"
  | "compatibleAuthReactSDKVersions"
  | "compatibleWebJSSDKVersions"> & object;
```

Defined in: [types.ts:571](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L571)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `initialized` | `boolean` | [types.ts:574](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L574) |

***

### ThemeBaseProps

```ts check=false reason="Generated API signature"
type ThemeBaseProps = object;
```

Defined in: [types.ts:421](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L421)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="stylefrominit"></a> `styleFromInit?` | `string` | [types.ts:422](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L422) |

***

### UserContext

```ts check=false reason="Generated API signature"
type UserContext = Record<string, any>;
```

Defined in: [types.ts:455](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L455)

***

### ValidationFailureCallback

```ts check=false reason="Generated API signature"
type ValidationFailureCallback = 
  | ({
          userContext,
          reason,
      }) => Promise<string | undefined> | string | undefined
  | undefined;
```

Defined in: [types.ts:80](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L80)

***

### WebJSRecipeInterface\<T\>

```ts check=false reason="Generated API signature"
type WebJSRecipeInterface<T> = Omit<T, "default" | "init" | "signOut">;
```

Defined in: [types.ts:195](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L195)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Variables

### nonPublicConfigProperties

```ts check=false reason="Generated API signature"
const nonPublicConfigProperties: readonly ["experimental"];
```

Defined in: [types.ts:564](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L564)