[Doc] Improve doc for <Autocomplete onCreate> and similar props
#9858
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
fzaninotto
commented
May 18, 2024
| @@ -166,32 +166,6 @@ You can filter the query used to populate the possible values. Use the `filter` | |||
|
|
|||
| **Note**: When users type a search term in the `<AutocompleteInput>`, this doesn't affect the `filter` prop. Check the [Customizing the filter query](#customizing-the-filter-query) section below for details on how that filter works. | |||
|
|
|||
| ## `format` | |||
There was a problem hiding this comment.
Moved below as " Transforming The Input Value" because the format prop doesn't actually exist in this component.
fzaninotto
commented
May 18, 2024
| { id: 4, name: 'Charles Baudelaire' }, | ||
| { id: 5, name: 'Marcel Proust' }, | ||
| ]; | ||
|
|
||
| export const OnCreate = () => ( |
There was a problem hiding this comment.
This story was broken since b6554db (my bad)
erwanMarmelab
approved these changes
May 20, 2024
docs/img/SelectInput-onCreate.mp4
Outdated
There was a problem hiding this comment.
nitpick (non-blocking):
I'm not sure that keeping the black browser strip is useful for this screencast
There was a problem hiding this comment.
If I don't, the alert is cut (as it is anchored to the URL input rather than the window top)
Co-authored-by: erwanMarmelab <131013150+erwanMarmelab@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.
Problem
I had to enable choice creation in an AutocompleteInput. I followed the docs and I didn't manage to do it. I had to dig down the code.
Solution
Improve choice creation documentation
Note: I know that there is still work to do for ReferenceArrayInput & co, but Rome wasn't built in a day and this is enough for a PR.