Merge pull request #8068 from marmelab/doc-ts-improvements

antoinefricker · web-flow · commit 2fe32c425fd4 · 2022-08-12T15:11:54.000+02:00
[Doc] Add `label` prop for `&lt;ReferenceInput&gt;` and `&lt;ReferenceArrayInput&gt;` in docs
diff --git a/docs/ReferenceArrayInput.md b/docs/ReferenceArrayInput.md
@@ -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
diff --git a/docs/ReferenceInput.md b/docs/ReferenceInput.md
@@ -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
diff --git a/docs/Upgrade.md b/docs/Upgrade.md
@@ -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.

Original file line number	Diff line number	Diff line change
`@@ -2709,6 +2709,8 @@ const UserInput = [`
`2709`	`2709`	`]`
`2710`	`2710`	```
`2711`	`2711`
	`2712`	+Note: `<ReferenceInput>` and `<ReferenceArrayInput>` still accept the `label` prop, which is used as the Filter label when they are used in a Filter array.
	`2713`	`+`
`2712`	`2714`	#### `<ReferenceArrayInput>` No Longer Provides a `ListContext`
`2713`	`2715`
`2714`	`2716`	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.