Skip to content

Commit 4847dc6

Browse files
fzaninottofzaninotto
authored
Merge pull request #5777 from WiXSL/fix-typos-md
[Docs] Fix docs typos
2 parents 01f59cb + ba1884c commit 4847dc6

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

‎docs/Inputs.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -527,8 +527,8 @@ import { AutocompleteInput } from 'react-admin';
527527
| `emptyValue` | Optional | `any` | `''` | The value to use for the empty element |
528528
| `emptyText` | Optional | `string` | `''` | The text to use for the empty element |
529529
| `matchSuggestion` | Optional | `Function` | `-` | Required if `optionText` is a React element. Function returning a boolean indicating whether a choice matches the filter. `(filter, choice) => boolean` |
530-
| `optionText` | Optional | `string` | `Function` | `Component` | `name` | Fieldname of record to display in the suggestion item or function which accepts the correct record as argument (`(record)=> {string}`) |
531-
| `optionValue` | Optional | `string` | `id` | Fieldname of record containing the value to use as input value |
530+
| `optionText` | Optional | `string` | `Function` | `Component` | `name` | Field name of record to display in the suggestion item or function which accepts the correct record as argument (`(record)=> {string}`) |
531+
| `optionValue` | Optional | `string` | `id` | Field name of record containing the value to use as input value |
532532
| `inputText` | Optional | `Function` | `-` | If `optionText` is a custom Component, this function is needed to determine the text displayed for the current selection. |
533533
| `resettable` | Optional | `boolean` | `false` | Display a button to reset the text filter. Useful when using `<AutocompleteInput>` inside `<Filter>` |
534534
| `setFilter` | Optional | `Function` | `null` | A callback to inform the `searchText` has changed and new `choices` can be retrieved based on this `searchText`. Signature `searchText => void`. This function is automatically setup when using `ReferenceInput`. |
@@ -687,8 +687,8 @@ import { RadioButtonGroupInput } from 'react-admin';
687687
| ----------------- | -------- | -------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
688688
| `choices` | Required | `Object[]` | - | List of items to show as options |
689689
| `options` | Optional | `Object` | - | Props to pass to the underlying `<RadioButtonGroup>` element |
690-
| `optionText` | Optional | `string` &#124; `Function` | `name` | Fieldname of record to display in the suggestion item or function which accepts the current record as argument (`(record)=> {string}`) |
691-
| `optionValue` | Optional | `string` | `id` | Fieldname of record containing the value to use as input value |
690+
| `optionText` | Optional | `string` &#124; `Function` | `name` | Field name of record to display in the suggestion item or function which accepts the current record as argument (`record => {string}`) |
691+
| `optionValue` | Optional | `string` | `id` | Field name of record containing the value to use as input value |
692692
| `row` | Optional | `boolean` | `true` | Display options in a compact row. |
693693
| `translateChoice` | Optional | `boolean` | `true` | Whether the choices should be translated |
694694

@@ -797,8 +797,8 @@ import { SelectInput } from 'react-admin';
797797
| `choices` | Required | `Object[]` | - | List of items to show as options |
798798
| `emptyText` | Optional | `string` | '' | The text to display for the empty option |
799799
| `options` | Optional | `Object` | - | Props to pass to the underlying `<SelectInput>` element |
800-
| `optionText` | Optional | `string` &#124; `Function` | `name` | Fieldname of record to display in the suggestion item or function which accepts the current record as argument (`(record)=> {string}`) |
801-
| `optionValue` | Optional | `string` | `id` | Fieldname of record containing the value to use as input value |
800+
| `optionText` | Optional | `string` &#124; `Function` | `name` | Field name of record to display in the suggestion item or function which accepts the current record as argument (`record => {string}`) |
801+
| `optionValue` | Optional | `string` | `id` | Field name of record containing the value to use as input value |
802802
| `resettable` | Optional | `boolean` | `false` | If `true`, display a button to reset the changes in this input value |
803803
| `translateChoice` | Optional | `boolean` | `true` | Whether the choices should be translated |
804804

@@ -1038,8 +1038,8 @@ import { AutocompleteArrayInput } from 'react-admin';
10381038
| `allowDuplicates` | Optional | `boolean` | `false` | If `true`, the options can be selected several times |
10391039
| `choices` | Required | `Object[]` | - | List of items to autosuggest |
10401040
| `matchSuggestion` | Optional | `Function` | - | Required if `optionText` is a React element. Function returning a boolean indicating whether a choice matches the filter. `(filter, choice) => boolean` |
1041-
| `optionValue` | Optional | `string` | `id` | Fieldname of record containing the value to use as input value |
1042-
| `optionText` | Optional | `string` &#124; `Function` | `name` | Fieldname of record to display in the suggestion item or function which accepts the current record as argument (`(record)=> {string}`) |
1041+
| `optionValue` | Optional | `string` | `id` | Field name of record containing the value to use as input value |
1042+
| `optionText` | Optional | `string` &#124; `Function` | `name` | Field name of record to display in the suggestion item or function which accepts the current record as argument (`record => {string}`) |
10431043
| `setFilter` | Optional | `Function` | `null` | A callback to inform the `searchText` has changed and new `choices` can be retrieved based on this `searchText`. Signature `searchText => void`. This function is automatically setup when using `ReferenceInput`. |
10441044
| `shouldRenderSuggestions` | Optional | `Function` | `() => true` | A function that returns a `boolean` to determine whether or not suggestions are rendered. Use this when working with large collections of data to improve performance and user experience. This function is passed into the underlying react-autosuggest component. Ex.`(value) => value.trim() > 2` |
10451045
| `source` | Required | `string` | - | Name of field to edit, its type should match the type retrieved from `optionValue` |
@@ -1180,8 +1180,8 @@ import { CheckboxGroupInput } from 'react-admin';
11801180
| Prop | Required | Type | Default | Description |
11811181
| ------------- | -------- | -------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
11821182
| `choices` | Required | `Object[]` | - | List of choices |
1183-
| `optionText` | Optional | `string` &#124; `Function` | `name` | Fieldname of record to display in the suggestion item or function which accepts the correct record as argument (`(record)=> {string}`) |
1184-
| `optionValue` | Optional | `string` | `id` | Fieldname of record containing the value to use as input value |
1183+
| `optionText` | Optional | `string` &#124; `Function` | `name` | Field name of record to display in the suggestion item or function which accepts the correct record as argument (`record => {string}`) |
1184+
| `optionValue` | Optional | `string` | `id` | Field name of record containing the value to use as input value |
11851185
| `row` | Optional | `boolean` | `true` | Display group of elements in a compact row. |
11861186

11871187
Refer to [Material UI Checkbox documentation](https://material-ui.com/api/checkbox/) for more details.

‎docs/List.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1400,7 +1400,7 @@ If you want to display a full-text search allowing to look for any record in the
14001400

14011401
![ra-search basic](https://marmelab.com/ra-enterprise/modules/assets/ra-search-overview.gif)
14021402

1403-
`ra-search` can plug to any existing search engine (ElasticSearch, Lucene, or custom search engine), and lets you customize the search results to provide quick navigation to related items, turniun the search engine into an "Omnibox":
1403+
`ra-search` can plug to any existing search engine (ElasticSearch, Lucene, or custom search engine), and lets you customize the search results to provide quick navigation to related items, turning the search engine into an "Omnibox":
14041404

14051405
![ra-search demo](https://marmelab.com/ra-enterprise/modules/assets/ra-search-demo.gif)
14061406

0 commit comments

Comments
 (0)