Skip to content

Added some documentation on the data structure required by a StaticDataProvider. #423

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jan 4, 2025
Merged

Added some documentation on the data structure required by a StaticDataProvider. #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3bab43
Added note regarding data structure for static data providers used in…
Jan 4, 2025
4c130d7
Added release note as requested by PR template
Jan 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion next-release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
### Features

### Bug Fixes and Improvements
- Added some documentation on the data structure required by a StaticDataProvider.

### Other Changes
-->
-->
2 changes: 2 additions & 0 deletions packages/docs/docs/guides/uncontrolled-environment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ function App() {
}
```

Note that for each item in the data structure representing the tree (`items` in this case), each object must have a field named `index` that has the same value as the key for that object. The `children` array can only refer to these values as well.

## Component Props

The props for the `UncontrolledTreeEnvironment` are as follows:
Expand Down