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

alzeebum · web-flow · commit 1a2f9a8dd3fa · 2025-01-04T16:36:43.000+01:00
* Added note regarding data structure for static data providers used in an uncontrolled environment.

* Added release note as requested by PR template

---------

Co-authored-by: alzeebum &lt;alzeebum&gt;
diff --git a/next-release-notes.md b/next-release-notes.md
@@ -4,6 +4,7 @@
 ### Features
 
 ### Bug Fixes and Improvements
+ - Added some documentation on the data structure required by a StaticDataProvider.
 
 ### Other Changes
--->
+-->
diff --git a/packages/docs/docs/guides/uncontrolled-environment.mdx b/packages/docs/docs/guides/uncontrolled-environment.mdx
@@ -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:

Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,8 @@ function App() {`
`58`	`58`	`}`
`59`	`59`	```
`60`	`60`
	`61`	+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.
	`62`	`+`
`61`	`63`	`## Component Props`
`62`	`64`
`63`	`65`	The props for the `UncontrolledTreeEnvironment` are as follows: