[Doc] Add section about filters in List documentation #4675
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
djhi
requested changes
Apr 10, 2020
docs/List.md
Outdated
| ); | ||
| ``` | ||
|
|
||
| In the example given above, the `q` filter triggers a full-text search on all fields. It's your responsibility to implement the full-text filtering capabilities in your API. |
There was a problem hiding this comment.
I would probably be nice to explain the q filter can be handled/converted in the dataProvider as well
docs/List.md
Outdated
| ); | ||
| ``` | ||
|
|
||
| Normally, `showFilter()` enables one filter, but we'll use here to show the entire form. |
Co-Authored-By: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-Authored-By: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-Authored-By: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The "Filter" keyword is the most searched in the react-admin documentation, according to our search engine analytics.
We can probably provide more details about the filtering capabilities of the List component. It's the purpose of this new section.