Skip to content

[Doc] Remove emptyText prop from <AutoCompleteArrayInput> doc as it is not supported #9073

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slax57 merged 3 commits into from
Jul 17, 2023
Merged

[Doc] Remove emptyText prop from <AutoCompleteArrayInput> doc as it is not supported #9073

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82bd539
pushing RA-OSS-10 to client
gitstart Jul 4, 2023
05997a0
Merge commit '205e5aeeb1e136be5863e038de8da0d39446160a' into RA-OSS-10
gitstart Jul 13, 2023
daa933a
revert change - change docs
gitstart Jul 13, 2023
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
17 changes: 0 additions & 17 deletions docs/AutocompleteArrayInput.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ The form value for the source must be an array of the selected values, e.g.
| `createLabel` | Optional | `string` | `ra.action. create` | The label for the menu item allowing users to create a new choice. Used when the filter is empty |
| `createItemLabel` | Optional | `string` | `ra.action .create_item` | The label for the menu item allowing users to create a new choice. Used when the filter is not empty |
| `debounce` | Optional | `number` | `250` | The delay to wait before calling the setFilter function injected when used in a ReferenceArray Input. |
| `emptyText` | Optional | `string` | `''` | The text to use for the empty element |
| `emptyValue` | Optional | `any` | `''` | The value to use for the empty element |
| `filterToQuery` | Optional | `string` => `Object` | `q => ({ q })` | How to transform the searchText into a parameter for the data provider |
| `inputText` | Optional | `Function` | `-` | Required if `optionText` is a custom Component, this function must return the text displayed for the current selection. |
Expand Down Expand Up @@ -228,22 +227,6 @@ This delay can be customized by setting the `debounce` prop.
</ReferenceArrayInput>
```

## `emptyText`

If the input isn't required (using `validate={required()}`), and you need a choice to represent the empty value, set `emptyText` prop and a choice will be added at the top, with its value as label.

```jsx
<AutocompleteArrayInput source="roles" choices={choices} emptyText="No role" />
```

The `emptyText` prop accepts either a string or a React Element.

And if you want to hide that empty choice, make the input required.

```jsx
<AutocompleteArrayInput source="roles" choices={choices} validate={required()} />
```

## `emptyValue`

If the input isn't required (using `validate={required()}`), users can select an empty choice. The default value for that empty choice is the empty string (`''`), or `null` if the input is inside a [`<ReferenceArrayInput>`](./ReferenceArrayInput.md).
Expand Down