metamask-extension/ui/pages/unlock-page/README.mdx

import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';

import UnlockPage from '.';

# Unlock Page

Portal page for user to auth the access of their account

<Canvas>
  <Story id="pages-unlockpage--default-story" />
</Canvas>

## Props

<!--
ArgsTable doesn't work with SectionShape
<ArgsTable of={MetaMaskTranslation} />
-->

| Name                       | Description                                                                |
| -------------------------- | -------------------------------------------------------------------------- |
| `history`                  | History router for redirect after action `object`                          |
| `isUnlocked`               | If isUnlocked is true will redirect to most recent route in history `bool` |
| `onRestore`                | onClick handler for "Forgot password?" link `func`      |
| `onSubmit`                 | onSumbit handler when form is submitted `func`                             |
| `forceUpdateMetamaskState` | Force update metamask data state `func`                                    |