Skip to content

Commit 284bfea

Browse files
committed
[Doc] Improve the List doc
1 parent 2381555 commit 284bfea

File tree

3 files changed

+86
-66
lines changed

3 files changed

+86
-66
lines changed

docs/Create.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ You can customize the `<Create>` component using the following props:
5757

5858
| Prop | Required | Type | Default | Description |
5959
|---------------------|----------|---------------------|----------------|--------------------------------------------------------------------------------------------------|
60-
| `children` | Optional* | `ReactNode` | - | The components that render the form |
61-
| `render` | Optional* | `function` | - | Alternative to children. Function that renders the form, receives the create context as argument |
60+
| `children` | Optional&nbsp;* | `ReactNode` | - | The components that render the form |
61+
| `render` | Optional&nbsp;* | `function` | - | Alternative to children. Function that renders the form, receives the create context as argument |
6262
| `actions` | Optional | `ReactNode` | Default toolbar| Override the actions toolbar with a custom component |
6363
| `aside` | Optional | `ReactNode` | - | Component to render aside to the main content |
6464
| `className` | Optional | `string` | - | Passed to the root component |
@@ -371,7 +371,7 @@ const PostCreate = () => ()
371371

372372
{% endraw %}
373373

374-
**Tip**: When receiving a render prop the `<Create>` component will ignore the children property.
374+
**Tip**: When receiving a `render` prop, the `<Create>` component will ignore the `children` prop.
375375

376376
## `resource`
377377

docs/Edit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ You can customize the `<Edit>` component using the following props:
6565

6666
| Prop | Required | Type | Default | Description |
6767
|-----------------------|-----------|---------------------|--------------|-----------------------------------------------------------------------------------------------|
68-
| `children` | Optional * | `ReactNode` | - | The components that render the form |
69-
| `render` | Optional * | `function` | - | Function to render the form, receives the editContext as argument |
68+
| `children` | Optional&nbsp;* | `ReactNode` | - | The components that render the form |
69+
| `render` | Optional&nbsp;* | `function` | - | Function to render the form, receives the editContext as argument |
7070
| `actions` | Optional | `ReactNode` | - | Override the actions toolbar with a custom component |
7171
| `aside` | Optional | `ReactNode` | - | Component to render aside to the main content |
7272
| `className` | Optional | `string` | - | Passed to the root component |
@@ -631,7 +631,7 @@ export const PostEdit = () => (
631631

632632
{% endraw %}
633633

634-
**Tip**: When receiving a `render` prop, the `<Edit>` component will ignore the `children` property.
634+
**Tip**: When receiving a `render` prop, the `<Edit>` component will ignore the `children` prop.
635635

636636
## `resource`
637637

0 commit comments

Comments
 (0)