1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 01:39:44 +01:00
metamask-extension/ui/pages/unlock-page
Nidhi Kumari 7424e98416
Updated all instances of "Component API" to "Props" in storybook documentation (#15324)
* replaced Component API with Props

* replaced Component API with Props in DOCUMENTATION.stories.mdx

* removed base avatar component
2022-07-27 00:22:40 +05:30
..
index.js remove the ui/app and ui/lib folders (#10911) 2021-04-28 14:53:59 -05:00
index.scss Overall CSS #13441 (#13902) 2022-05-16 13:38:04 -05:00
README.mdx Updated all instances of "Component API" to "Props" in storybook documentation (#15324) 2022-07-27 00:22:40 +05:30
unlock-page.component.js MetaMetrics: Add EVENT.CATEGORIES const (#14474) 2022-04-22 13:09:10 -03:00
unlock-page.component.test.js Update "Forgot Password?" copy (#13493) 2022-02-22 10:45:19 -05:00
unlock-page.container.js remove the ui/app and ui/lib folders (#10911) 2021-04-28 14:53:59 -05:00
unlock-page.container.test.js remove the ui/app and ui/lib folders (#10911) 2021-04-28 14:53:59 -05:00
unlock-page.stories.js Fix unlock-page component for new Storybook format (#12894) 2021-12-06 15:08:13 -08:00

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="ui-pages-unlock-page-unlock-page-stories-js--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`                                    |
| `showOptInModal`           | Event handler to show metametrics modal `func`                             |