1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-05 15:35:46 +01:00
metamask-extension/ui/pages/unlock-page/README.mdx
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

28 lines
1.2 KiB
Plaintext

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` |