Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Fix Confirm prop table overflows #8985

Merged
merged 1 commit into from
Jun 7, 2023
Merged

[Doc] Fix Confirm prop table overflows #8985

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/Confirm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,16 @@ const BulkResetViewsButton = () => {
|--------------------|----------|----------------------------------|-----------------------|--------------------------------------------------------------------|
| `title` | Required | `string` | - | Title of the dialog |
| `content` | Required | `ReactNode` | - | Body of the dialog |
| `onClose` | Required | `MouseEventHandler` | - | onClick event handler of the cancel button |
| `onConfirm` | Required | `MouseEventHandler` | - | onClick event handler of the confirm button |
| `onClose` | Required | `Mouse EventHandler` | - | onClick event handler of the cancel button |
| `onConfirm` | Required | `Mouse EventHandler` | - | onClick event handler of the confirm button |
| `isOpen` | Optional | `boolean` | `false` | `true` to show the dialog, `false` to hide it |
| `loading` | Optional | `boolean` | `false` | Boolean to be applied to the `disabled` prop of the action buttons |
| `cancel` | Optional | `string` | 'ra.action.cancel' | Label of the cancel button |
| `confirm` | Optional | `string` | 'ra.action.confirm' | Label of the confirm button |
| `cancel` | Optional | `string` | 'ra.action. cancel' | Label of the cancel button |
| `confirm` | Optional | `string` | 'ra.action. confirm' | Label of the confirm button |
| `confirmColor` | Optional | `string` | 'primary' | Color of the confirm button |
| `ConfirmIcon` | Optional | `ReactElement` | `<CheckCircle/>` | Icon element of the confirm button |
| `CancelIcon` | Optional | `ReactElement` | `<ErrorOutlineIcon/>` | Icon element of the cancel button |
| `translateOptions` | Optional | `{ id?: string, name?: string }` | {} | Custom id and name to be used in the dialog title |
| `ConfirmIcon` | Optional | `ReactElement` | `<Check Circle/>` | Icon element of the confirm button |
| `CancelIcon` | Optional | `ReactElement` | `<Error OutlineIcon/>` | Icon element of the cancel button |
| `translate Options` | Optional | `{ id?: string, name?: string }` | {} | Custom id and name to be used in the dialog title |
| `sx` | Optional | `SxProps` | '' | Material UI shortcut for defining custom styles with access to the theme |

Text props such as `title`, `content`, `cancel`, `confirm` and `translateOptions` are translatable. You can pass translation keys in these props. Note: `content` is only translatable when value is `string`, otherwise it renders the content as a `ReactNode`.
Expand Down