Skip to content

Commit d5727bc

Browse files
MadeorskMadeorsk
committed
Fix | in docs.
1 parent 5312d69 commit d5727bc

File tree

6 files changed

+103
-103
lines changed

6 files changed

+103
-103
lines changed

‎docs/DataTable.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -970,21 +970,21 @@ export const PostList = () => (
970970

971971
### Props
972972

973-
| Prop | Required | Type | Default | Description |
974-
| -------------------- | -------- | ----------------------- | --------------------- | ------------------------------------------------------------- |
975-
| `align` | Optional | `"left" \| "right"` | `"left"` | The alignment of the column. |
976-
| `children` | Optional | ReactNode | - | The content of the column. |
977-
| `cellClassName` | Optional | string | - | The class name of the cells. |
978-
| `cellSx` | Optional | function | - | A function that returns the sx prop to apply to a cell. |
979-
| `className` | Optional | string | - | The class name of the column. |
980-
| `disableSort` | Optional | boolean | false | Set to true to disable sort. |
981-
| `field` | Optional | Component | - | The field component to use for the column. |
982-
| `headerClassName` | Optional | string | - | The class name of the header cell. |
983-
| `label` | Optional | string | - | The column label, displayed in the header. |
984-
| `render` | Optional | (record) => ReactNode | - | A function to render the column content. |
985-
| `sortByOrder` | Optional | "ASC" \| "DESC" | "ASC" | The order to use for sorting the column. |
986-
| `source` | Optional | string | - | The source of the column, used for sorting and to read the data from the record when there is no child. |
987-
| `sx` | Optional | SxProps | - | The styles to apply to the column. |
973+
| Prop | Required | Type | Default | Description |
974+
|-------------------|------------|---------------------------|------------|---------------------------------------------------------------------------------------------------------|
975+
| `align` | Optional | `"left"` | `"right"` | `"left"` | The alignment of the column. |
976+
| `children` | Optional | ReactNode | - | The content of the column. |
977+
| `cellClassName` | Optional | string | - | The class name of the cells. |
978+
| `cellSx` | Optional | function | - | A function that returns the sx prop to apply to a cell. |
979+
| `className` | Optional | string | - | The class name of the column. |
980+
| `disableSort` | Optional | boolean | `false` | Set to true to disable sort. |
981+
| `field` | Optional | Component | - | The field component to use for the column. |
982+
| `headerClassName` | Optional | string | - | The class name of the header cell. |
983+
| `label` | Optional | string | - | The column label, displayed in the header. |
984+
| `render` | Optional | (record) => ReactNode | - | A function to render the column content. |
985+
| `sortByOrder` | Optional | `"ASC"` | `"DESC"` | `"ASC"` | The order to use for sorting the column. |
986+
| `source` | Optional | string | - | The source of the column, used for sorting and to read the data from the record when there is no child. |
987+
| `sx` | Optional | SxProps | - | The styles to apply to the column. |
988988

989989
Additional props are passed to [the MUI `<TableCell>`](https://mui.com/material-ui/api/table-cell/) component.
990990

‎docs/Edit.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -63,30 +63,30 @@ export default App;
6363

6464
You can customize the `<Edit>` component using the following props:
6565

66-
| Prop | Required | Type | Default | Description |
67-
|-------------------------|-----------------|-----------------------------------------------|--------------|-----------------------------------------------------------------------------------------|
68-
| `authLoading` | Optional | `ReactNode` | | The component to render while checking for authentication and permissions |
69-
| `children` | Optional&nbsp;* | `ReactNode` | - | The components that render the form |
70-
| `render` | Optional&nbsp;* | `function` | - | Function to render the form, receives the editContext as argument |
71-
| `actions` | Optional | `ReactNode` | - | Override the actions toolbar with a custom component |
72-
| `aside` | Optional | `ReactNode` | - | Component to render aside to the main content |
73-
| `className` | Optional | `string` | - | Passed to the root component |
74-
| `component` | Optional | `elementType`/`string` | `Card` | Override the root component |
75-
| `disableAuthentication` | Optional | `boolean` | `false` | Disable the authentication check |
76-
| `error` | Optional | `ReactNode` | | The component to render when failing to load the record |
77-
| `emptyWhileLoading` | Optional | `boolean` | `false` | Set to `true` to return `null` while the edit is loading |
78-
| `id` | Optional | `string`/`number` | - | The id of the record to edit |
79-
| `loading` | Optional | `ReactNode` | | The component to render while loading the record to edit |
80-
| `mutationMode` | Optional | `'undoable' \| 'optimistic' \| 'pessimistic'` | `'undoable'` | Switch to optimistic or pessimistic mutations |
81-
| `mutationOptions` | Optional | `object` | - | Options for the `dataProvider.update()` call |
82-
| `offline` | Optional | `ReactNode` | | The component to render when there is no connectivity and the record isn't in the cache |
83-
| `queryOptions` | Optional | `object` | - | Options for the `dataProvider.getOne()` call |
84-
| `redirect` | Optional | `'list' \| 'show' \| false \| function` | `'list'` | Change the redirect location after successful update |
85-
| `resource` | Optional | `string` | - | Override the name of the resource to edit |
86-
| `sx` | Optional | `object` | - | Override the styles |
87-
| `title` | Optional | `string`/`ReactNode`/`false` | - | Override the page title |
88-
| `redirectOnError` | Optional | `'list' \| false \| function` | `'list'` | The page to redirect to when an error occurs |
89-
| `transform` | Optional | `function` | - | Transform the form data before calling `dataProvider.update()` |
66+
| Prop | Required | Type | Default | Description |
67+
|-------------------------|-----------------|-----------------------------------------------------------|--------------|-----------------------------------------------------------------------------------------|
68+
| `authLoading` | Optional | `ReactNode` | | The component to render while checking for authentication and permissions |
69+
| `children` | Optional&nbsp;* | `ReactNode` | - | The components that render the form |
70+
| `render` | Optional&nbsp;* | `function` | - | Function to render the form, receives the editContext as argument |
71+
| `actions` | Optional | `ReactNode` | - | Override the actions toolbar with a custom component |
72+
| `aside` | Optional | `ReactNode` | - | Component to render aside to the main content |
73+
| `className` | Optional | `string` | - | Passed to the root component |
74+
| `component` | Optional | `elementType` &#124; `string` | `Card` | Override the root component |
75+
| `disableAuthentication` | Optional | `boolean` | `false` | Disable the authentication check |
76+
| `error` | Optional | `ReactNode` | | The component to render when failing to load the record |
77+
| `emptyWhileLoading` | Optional | `boolean` | `false` | Set to `true` to return `null` while the edit is loading |
78+
| `id` | Optional | `string`/`number` | - | The id of the record to edit |
79+
| `loading` | Optional | `ReactNode` | | The component to render while loading the record to edit |
80+
| `mutationMode` | Optional | `'undoable'` &#124; `'optimistic'` &#124; `'pessimistic'` | `'undoable'` | Switch to optimistic or pessimistic mutations |
81+
| `mutationOptions` | Optional | `object` | - | Options for the `dataProvider.update()` call |
82+
| `offline` | Optional | `ReactNode` | | The component to render when there is no connectivity and the record isn't in the cache |
83+
| `queryOptions` | Optional | `object` | - | Options for the `dataProvider.getOne()` call |
84+
| `redirect` | Optional | `'list'` &#124; `'show'` &#124; `false` &#124; `function` | `'list'` | Change the redirect location after successful update |
85+
| `resource` | Optional | `string` | - | Override the name of the resource to edit |
86+
| `sx` | Optional | `object` | - | Override the styles |
87+
| `title` | Optional | `string` &#124; `ReactNode` &#124; `false` | - | Override the page title |
88+
| `redirectOnError` | Optional | `'list'` &#124; `false` &#124; `function` | `'list'` | The page to redirect to when an error occurs |
89+
| `transform` | Optional | `function` | - | Transform the form data before calling `dataProvider.update()` |
9090

9191
`*` You must provide either `children` or `render`.
9292

‎docs/EditBase.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -44,21 +44,21 @@ export const BookEdit = () => (
4444

4545
## Props
4646

47-
| Prop | Required | Type | Default | Description
48-
|--------------------------|--------------|----------------------------------------------------------|----------|--------------------------------------------------------
49-
| `authLoading` | Optional | `ReactNode` | | The component to render while checking for authentication and permissions
50-
| `children` | Optional | `ReactNode` | | The components rendering the record fields
51-
| `render` | Optional | `(props: EditControllerResult<RecordType>) => ReactNode` | | Alternative to children, a function that takes the EditController context and renders the form
52-
| `disable Authentication` | Optional | `boolean` | | Set to `true` to disable the authentication check
53-
| `error` | Optional | `ReactNode` | | The component to render when failing to load the record
54-
| `id` | Optional | `string` | | The record identifier. If not provided, it will be deduced from the URL
55-
| `loading` | Optional | `ReactNode` | | The component to render while loading the record to edit
56-
| `mutationMode` | Optional | `undoable` | | The mutation mode
57-
| `mutationOptions` | Optional | `ReactNode` | | The options to pass to the `useUpdate` hook
58-
| `offline` | Optional | `ReactNode` | | The component to render when there is no connectivity and the record isn't in the cache
59-
| `queryOptions` | Optional | `object` | | The options to pass to the `useGetOne` hook
60-
| `redirectOnError` | Optional | `'list' \| false \| function` | `'list'` | The page to redirect to when an error occurs
61-
| `transform` | Optional | `string` | | Transform the form data before calling `dataProvider.update()`
47+
| Prop | Required | Type | Default | Description
48+
|--------------------------|----------|----------------------------------------------------------|----------|--------------------------------------------------------
49+
| `authLoading` | Optional | `ReactNode` | | The component to render while checking for authentication and permissions
50+
| `children` | Optional | `ReactNode` | | The components rendering the record fields
51+
| `render` | Optional | `(props: EditControllerResult<RecordType>) => ReactNode` | | Alternative to children, a function that takes the EditController context and renders the form
52+
| `disable Authentication` | Optional | `boolean` | | Set to `true` to disable the authentication check
53+
| `error` | Optional | `ReactNode` | | The component to render when failing to load the record
54+
| `id` | Optional | `string` | | The record identifier. If not provided, it will be deduced from the URL
55+
| `loading` | Optional | `ReactNode` | | The component to render while loading the record to edit
56+
| `mutationMode` | Optional | `undoable` | | The mutation mode
57+
| `mutationOptions` | Optional | `ReactNode` | | The options to pass to the `useUpdate` hook
58+
| `offline` | Optional | `ReactNode` | | The component to render when there is no connectivity and the record isn't in the cache
59+
| `queryOptions` | Optional | `object` | | The options to pass to the `useGetOne` hook
60+
| `redirectOnError` | Optional | `'list'` &#124; `false` &#124; `function` | `'list'` | The page to redirect to when an error occurs
61+
| `transform` | Optional | `string` | | Transform the form data before calling `dataProvider.update()`
6262

6363
## `authLoading`
6464

0 commit comments

Comments
 (0)