-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] New documentation page State
#3431
Merged
Merged
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
flaviendelangle
added
component: data grid
This is the name of the generic UI component, not the React module!
docs
Improvements or additions to the documentation
labels
Dec 14, 2021
flaviendelangle
changed the title
[docs] Document the selectors
[docs] New documentation page Dec 14, 2021
State
github-actions
bot
added
the
PR: out-of-date
The pull request has merge conflicts and can't be merged
label
Dec 14, 2021
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
github-actions
bot
removed
the
PR: out-of-date
The pull request has merge conflicts and can't be merged
label
Dec 15, 2021
DanailH
approved these changes
Jan 11, 2022
Co-authored-by: Danail Hadjiatanasov <hadjiatanasov@gmail.com>
Co-authored-by: Danail Hadjiatanasov <hadjiatanasov@gmail.com>
Co-authored-by: Danail Hadjiatanasov <hadjiatanasov@gmail.com>
Co-authored-by: Danail Hadjiatanasov <hadjiatanasov@gmail.com>
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
component: data grid
This is the name of the generic UI component, not the React module!
docs
Improvements or additions to the documentation
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.
Closes #3144
Doc preview
initialState
propdocs:api:build
script to generate a JSON with all the selectorsuseGridSelector
before state initialization instead of just letting the code crashFor Pagination / Filter / Sorting selectors:
Selectors
section on the doc page@ignore
for selectors we don't want to expose publiclyI think we should deprecate the ill-named selectors or selectors to be removed before documenting them.
So that the selector list on the documentation is clean.
For instance selection and columns selector have not yet be renamed correctly.
If there are selectors you think we should not document, tell me so. I don't document top level selectors like
gridFilterStateSeledctor
because I would like to stop exporting them from their file. To only expose the interesting values, not the whole sub-filter.I'm not a huge fan of the UI for the selector collection.
But I think the apiRef collection and events collection are not great either and that we need to rethink those 3 UIs to have something coherent.