Update keyField/data props Documentation #1362
Merged
Conversation
This file contains hidden or 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
I added more info to the descriptions of the keyField and data props of the Table component. I also added an example of what these properties might look like for a sample dataset. I had trouble figuring these out, and had to find a medium post about this library to understand how the input data should be formatted, and I had to read the source code to understand what the keyField was for. I think having better descriptions of these props will be helpful to users.
| thank u boss |
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.
I added more info to the descriptions of the keyField and data props of
the Table component. I also added an example of what these properties
might look like for a sample dataset.
I couldn't find any info in the documentation about how the data should be formatted or what that should look like (I found a medium post that explained it well), and I had to read the source code to understand what the keyField was for. I think having better descriptions of these props in the documentation will be helpful to users.