Added some documentation on the data structure required by a StaticDa…

…taProvider. (#423) * 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 <alzeebum>
lukasbach · Jan 4, 2025 · 1a2f9a8 · 1a2f9a8
1 parent fc0dbb0
commit 1a2f9a8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
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 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 @@