Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
@manojleaton
manojleaton committed Aug 12, 2024
1 parent 7e1d01f commit a11fd22
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions login-workflow/docs/components/change-password-dialog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import { AuthContextProvider, ChangePasswordDialog } from '@brightlayer-ui/react
| Prop Name | Type | Description | Default |
| ----------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| PasswordProps | `SetPasswordProps` | See [Set Password](./set-password.md) | |
| ErrorDialogProps | `BasicDialogProps` | Props to configure a nested error dialog if there are errors changing the password. See [Basic Dialog](./basic-dialog.md). | |
| dialogTitle | `string` | The title to display in the dialog. | `t('bluiAuth:CHANGE_PASSWORD_DIALOG.TITLE')` |
| dialogDescription | `string` | The description to display in the dialog. | `t('bluiAuth:CHANGE_PASSWORD_DIALOG.DESCRIPTION')` |
| currentPasswordLabel | `string` | The label to display for the current password field. | `t('bluiAuth:CHANGE_PASSWORD_DIALOG.CURRENT_PASSWORD_LABEL')` |
Expand All @@ -39,14 +38,14 @@ import { AuthContextProvider, ChangePasswordDialog } from '@brightlayer-ui/react

### ChangePasswordDialogSlots

| Key | Type | Description |
| ------------- | -------------------------------------------- | ------------------------------------------------------------------------------ |
| Key | Type | Description |
| ------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- |
| SuccessScreen | `(props: SuccessScreenProps) => JSX.Element` | A custom success screen component to render. See [SuccessScreen](../screens/success.md) |

### ChangePasswordDialogSlotsProps

| Key | Type | Description |
| ------------- | -------------------- | --------------------------------------------------------------------------------------- |
| Key | Type | Description |
| ------------- | -------------------- | ------------------------------------------------------------------------------------------------ |
| SuccessScreen | `SuccessScreenProps` | Props to pass to the custom success screen component. See [SuccessScreen](../screens/success.md) |

Props from the underlying MUI [Dialog](https://mui.com/material-ui/react-dialog/) are also available.

0 comments on commit a11fd22

Please sign in to comment.