Small updates to the TypeScript types (#65)

* Allow `childrenAccessor` function to return `null` * Express that this component won't change the `data` you pass it
brimdata · Nov 17, 2022 · cc941da · cc941da
1 parent 86b61e7
commit cc941da
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/packages/react-arborist/src/data/create-root.ts b/packages/react-arborist/src/data/create-root.ts
@@ -44,7 +44,7 @@ export function createRoot<T>(tree: TreeApi<T>): NodeApi<T> {
     rowIndex: null,
   });
 
-  const data: T[] = tree.props.data ?? [];
+  const data: readonly T[] = tree.props.data ?? [];
 
   root.children = data.map((child) => {
     return visitSelfAndChildren(child, 0, root);

diff --git a/packages/react-arborist/src/hooks/use-simple-tree.ts b/packages/react-arborist/src/hooks/use-simple-tree.ts
@@ -16,7 +16,7 @@ export type SimpleTreeData = {
 
 let nextId = 0;
 
-export function useSimpleTree<T>(initialData: T[]) {
+export function useSimpleTree<T>(initialData: readonly T[]) {
   const [data, setData] = useState(initialData);
   const tree = useMemo(
     () =>

diff --git a/packages/react-arborist/src/types/tree-props.ts b/packages/react-arborist/src/types/tree-props.ts
@@ -8,8 +8,8 @@ import { OpenMap, OpenSlice } from "../state/open-slice";
 
 export interface TreeProps<T> {
   /* Data Options */
-  data?: T[];
-  initialData?: T[];
+  data?: readonly T[];
+  initialData?: readonly T[];
 
   /* Data Handlers */
   onCreate?: handlers.CreateHandler<T>;
@@ -38,7 +38,7 @@ export interface TreeProps<T> {
   selectionFollowsFocus?: boolean;
   disableDrag?: string | boolean | BoolFunc<T>;
   disableDrop?: string | boolean | BoolFunc<T>;
-  childrenAccessor?: string | ((d: T) => T[]);
+  childrenAccessor?: string | ((d: T) => T[] | null);
   idAccessor?: string | ((d: T) => string);
 
   /* Event Handlers */