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

Jump to bottom

[Doc] Add label prop for <ReferenceInput> and <ReferenceArrayInput> in docs #8068

Merged
merged 5 commits into from
Aug 12, 2022
Merged

[Doc] Add label prop for <ReferenceInput> and <ReferenceArrayInput> in docs #8068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
eb3a6ea
ReferenceInput and ReferenceArrayInput accepts label when in filter a…
thibault-barrat Aug 12, 2022
bfc51f9
alphabetical order for props
thibault-barrat Aug 12, 2022
d330638
add explicit resettable in SelectInputProps
thibault-barrat Aug 12, 2022
9c6ac19
move TS fix in other PR
thibault-barrat Aug 12, 2022
affaa3a
comments from PR
thibault-barrat Aug 12, 2022
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
2 changes: 1 addition & 1 deletion docs/ReferenceArrayInput.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ import { ReferenceArrayInput, SelectArrayInput } from 'react-admin';
| Prop | Required | Type | Default | Description |
|--------------------|----------|---------------------------------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| `filter` | Optional | `Object` | `{}` | Permanent filters to use for getting the suggestion list |
| `label` | Optional | `string` | - | Useful only when `ReferenceArrayInput` is in a Filter array, the label is used as the Filter label. |
| `page` | Optional | `number` | 1 | The current page number |
| `perPage` | Optional | `number` | 25 | Number of suggestions to show |
| `reference` | Required | `string` | '' | Name of the reference resource, e.g. 'posts'. |
| `sort` | Optional | `{ field: String, order: 'ASC' or 'DESC' }` | `{ field: 'id', order: 'DESC' }` | How to order the list of suggestions |
| `enableGetChoices` | Optional | `({q: string}) => boolean` | `() => true` | Function taking the `filterValues` and returning a boolean to enable the `getList` call. |


**Note**: `<ReferenceArrayInput>` doesn't accept the [common input props](./Inputs.md#common-input-props) ; it is the responsability of children to apply them.

## Usage
Expand Down
2 changes: 1 addition & 1 deletion docs/ReferenceInput.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ import { ReferenceInput, SelectInput } from 'react-admin';
| Prop | Required | Type | Default | Description |
|--------------------|----------|---------------------------------------------|----------------------------------|-------------------------------------------------------------------------------------------------------------------|
| `filter` | Optional | `Object` | `{}` | Permanent filters to use for getting the suggestion list |
| `label` | Optional | `string` | - | Useful only when `ReferenceInput` is in a Filter array, the label is used as the Filter label. |
| `page` | Optional | `number` | 1 | The current page number |
| `perPage` | Optional | `number` | 25 | Number of suggestions to show |
| `reference` | Required | `string` | '' | Name of the reference resource, e.g. 'posts'. |
| `sort` | Optional | `{ field: String, order: 'ASC' or 'DESC' }` | `{ field: 'id', order: 'DESC' }` | How to order the list of suggestions |
| `enableGetChoices` | Optional | `({q: string}) => boolean` | `() => true` | Function taking the `filterValues` and returning a boolean to enable the `getList` call. |


**Note**: `<ReferenceInput>` doesn't accept the [common input props](./Inputs.md#common-input-props) ; it is the responsability of children to apply them.

## Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/Upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2709,6 +2709,8 @@ const UserInput = [
]
```

**Note**: `<ReferenceInput>` and `<ReferenceArrayInput>` still accept the `label` prop, which is used as the Filter label when they are used in a Filter array.

#### `<ReferenceArrayInput>` No Longer Provides a `ListContext`

As the `ChoicesContext` now provide an API very similar to the `ListContext`, it no longer sets up a `ListContext`. If you used this to display a `<Datagrid>`, we will soon provide the `<DatagridInput>` for this purpose.
Expand Down