docs: update reset-password doc page

sikka-software · Feb 8, 2024 · 2e4b2c1 · 2e4b2c1
1 parent b381d28
commit 2e4b2c1
Showing 1 changed file with 11 additions and 11 deletions.
diff --git a/apps/docs/content/docs/blocks/reset-password.mdx b/apps/docs/content/docs/blocks/reset-password.mdx
@@ -1,6 +1,6 @@
 ---
-title: Auth Buttons
-description: a collection of buttons for authentication
+title: Reset Password
+description: a minimal form for requesting a password reset
 component: true
 links:
   storybook: https://storybook.hawa.style/?path=/story/blocks-user-auth-auth-buttons--auth-buttons
@@ -12,15 +12,15 @@ links:
 
 The following props can be passed to the component
 
-| Prop                  | Type    | Default | Description                           |
-| --------------------- | ------- | ------- | ------------------------------------- |
-| [texts](#text)        |         |         | Text labels used throughout the form. |
-| handleResetPassword   |         |         |                                       |
-| handleRouteToRegister |         |         |                                       |
-| sent                  | boolean | false   |                                       |
-| headless              | boolean | false   |                                       |
-| allowRegister         |         |         |                                       |
-| direction             |         |         |                                       |
+| Prop                  | Type          | Default | Description                                                                                          |
+| --------------------- | ------------- | ------- | ---------------------------------------------------------------------------------------------------- |
+| [texts](#text)        |               |         | Text labels used throughout the form.                                                                |
+| handleResetPassword   | function      |         | This function is triggered when the form is submitted                                                |
+| handleRouteToRegister | function      |         | Use this function to redirect the user to registeration                                          |
+| sent                  | boolean       | false   | Should be set to true after the form is submitted to indicate to the user that the form is submitted |
+| headless              | boolean       | false   | show/hide the header text of the card                                                                |
+| allowRegister         | boolean       | true    | show/hide a text under the submit form that asks the user if they don't have an account              |
+| direction             | `ltr` \|`rtl` | `ltr`   | the direction of the block                                                                           |
 
 ## Texts