@headless-tree/core 0.0.5 → 0.0.6

package/src/features/tree/feature.ts

@@ -28,6 +28,11 @@ export const treeFeature: FeatureImplementation<
     ...defaultConfig,
   }),
 
+  stateHandlerNames: {
+    expandedItems: "setExpandedItems",
+    focusedItem: "setFocusedItem",
+  },
+
   createTreeInstance: (prev, instance) => ({
     ...prev,
 
@@ -45,7 +50,6 @@ export const treeFeature: FeatureImplementation<
     getItemsMeta: () => {
       const { rootItemId } = instance.getConfig();
       const { expandedItems } = instance.getState();
-      // console.log("!", instance.getConfig());
       const flatItems: ItemMeta[] = [];
 
       const recursiveAdd = (
@@ -91,9 +95,10 @@ export const treeFeature: FeatureImplementation<
         return;
       }
 
-      instance
-        .getConfig()
-        .setExpandedItems?.((expandedItems) => [...expandedItems, itemId]);
+      instance.applySubStateUpdate("expandedItems", (expandedItems) => [
+        ...expandedItems,
+        itemId,
+      ]);
       instance.rebuildTree();
     },
 
@@ -102,11 +107,9 @@ export const treeFeature: FeatureImplementation<
         return;
       }
 
-      instance
-        .getConfig()
-        .setExpandedItems?.((expandedItems) =>
-          expandedItems.filter((id) => id !== itemId)
-        );
+      instance.applySubStateUpdate("expandedItems", (expandedItems) =>
+        expandedItems.filter((id) => id !== itemId)
+      );
       instance.rebuildTree();
     },
 
@@ -119,7 +122,7 @@ export const treeFeature: FeatureImplementation<
     },
 
     focusItem: (itemId) => {
-      instance.getConfig().setFocusedItem?.(itemId);
+      instance.applySubStateUpdate("focusedItem", itemId);
     },
 
     focusNextItem: () => {
@@ -134,7 +137,7 @@ export const treeFeature: FeatureImplementation<
       instance.focusItem(instance.getItems()[nextIndex].getId());
     },
 
-    updateDomFocus: (scrollIntoView) => {
+    updateDomFocus: () => {
       // Required because if the state is managed outside in react, the state only updated during next render
       setTimeout(async () => {
         const focusedItem = instance.getFocusedItem();
@@ -143,9 +146,6 @@ export const treeFeature: FeatureImplementation<
         const focusedElement = focusedItem.getElement();
         if (!focusedElement) return;
         focusedElement.focus();
-        // if (scrollIntoView) {
-        //   focusedElement.scrollIntoView();
-        // }
       });
     },
 
@@ -162,6 +162,11 @@ export const treeFeature: FeatureImplementation<
     isLoading: () => {
       throw new Error("No data-loader registered");
     },
+    scrollTo: async (scrollIntoViewArg) => {
+      tree.getConfig().scrollToItem?.(item as any);
+      await poll(() => item.getElement() !== null, 20);
+      item.getElement()!.scrollIntoView(scrollIntoViewArg);
+    },
     getId: () => item.getItemMeta().itemId,
     getProps: () => {
       const itemMeta = item.getItemMeta();
@@ -170,12 +175,11 @@ export const treeFeature: FeatureImplementation<
         role: "treeitem",
         "aria-setsize": itemMeta.setSize,
         "aria-posinset": itemMeta.posInSet,
-        "aria-selected": false,
+        "aria-selected": "false",
         "aria-label": item.getItemName(),
         "aria-level": itemMeta.level,
         tabIndex: item.isFocused() ? 0 : -1,
         onClick: item.getMemoizedProp("tree/onClick", () => (e) => {
-          console.log("onClick", item.getId());
           item.setFocused();
           item.primaryAction();
 
@@ -225,10 +229,8 @@ export const treeFeature: FeatureImplementation<
       },
       () => [item.getItemMeta()]
     ),
-    getIndexInParent: () =>
-      item.getItemMeta().index -
-      (item.getParent()?.getItemMeta().index ?? 0) -
-      1,
+    // TODO remove
+    getIndexInParent: () => item.getItemMeta().posInSet,
     getChildren: () =>
       tree
         .retrieveChildrenIds(item.getItemMeta().itemId)
@@ -301,7 +303,7 @@ export const treeFeature: FeatureImplementation<
           item.getItemMeta().level !== 0
         ) {
           item.getParent()?.setFocused();
-          tree.updateDomFocus(true);
+          tree.updateDomFocus();
         } else {
           item.collapse();
         }

package/src/features/tree/types.ts

@@ -41,8 +41,7 @@ export type TreeFeatureDef<T> = {
     getFocusedItem: () => ItemInstance<any>;
     focusNextItem: () => void;
     focusPreviousItem: () => void;
-    scrollToItem: (item: ItemInstance<any>) => void;
-    updateDomFocus: (scrollIntoView?: boolean) => void;
+    updateDomFocus: () => void;
 
     getContainerProps: () => Record<string, any>;
   };
@@ -65,6 +64,9 @@ export type TreeFeatureDef<T> = {
     getItemAbove: () => ItemInstance<T> | null;
     getItemBelow: () => ItemInstance<T> | null;
     getMemoizedProp: <X>(name: string, create: () => X, deps?: any[]) => X;
+    scrollTo: (
+      scrollIntoViewArg?: boolean | ScrollIntoViewOptions
+    ) => Promise<void>;
   };
   hotkeys:
     | "focusNextItem"

package/src/index.ts

@@ -1,5 +1,6 @@
 export * from "./types/core";
 export * from "./core/create-tree";
+
 export * from "./features/tree/types";
 export * from "./features/main/types";
 export * from "./features/drag-and-drop/types";
@@ -20,4 +21,6 @@ export * from "./features/search/feature";
 export * from "./features/renaming/feature";
 export * from "./features/expand-all/feature";
 
-export * from "./data-adapters/nested-data-adapter";
+export * from "./utilities/create-on-drop-handler";
+export * from "./utilities/insert-items-at-target";
+export * from "./utilities/remove-items-from-parents";

package/src/types/core.ts

@@ -130,6 +130,10 @@ export type FeatureImplementation<
   key?: string;
   dependingFeatures?: string[];
 
+  stateHandlerNames?: Partial<
+    Record<keyof MergedFeatures<F>["state"], keyof MergedFeatures<F>["config"]>
+  >;
+
   getInitialState?: (
     initialState: Partial<MergedFeatures<F>["state"]>,
     tree: MergedFeatures<F>["treeInstance"]
@@ -174,9 +178,5 @@ export type FeatureImplementation<
     tree: MergedFeatures<F>["treeInstance"]
   ) => void;
 
-  setState?: (instance: MergedFeatures<F>["treeInstance"]) => void;
-  onConfigChange?: (instance: MergedFeatures<F>["treeInstance"]) => void;
-  onStateOrConfigChange?: (instance: MergedFeatures<F>["treeInstance"]) => void;
-
   hotkeys?: HotkeysConfig<T, D>;
 };

package/src/utilities/create-on-drop-handler.ts

@@ -0,0 +1,14 @@
+import { ItemInstance } from "../types/core";
+import { DropTarget } from "../features/drag-and-drop/types";
+import { removeItemsFromParents } from "./remove-items-from-parents";
+import { insertItemsAtTarget } from "./insert-items-at-target";
+
+export const createOnDropHandler =
+  <T>(
+    onChangeChildren: (item: ItemInstance<T>, newChildren: string[]) => void
+  ) =>
+  (items: ItemInstance<T>[], target: DropTarget<T>) => {
+    const itemIds = items.map((item) => item.getId());
+    removeItemsFromParents(items, onChangeChildren);
+    insertItemsAtTarget(itemIds, target, onChangeChildren);
+  };

package/src/utilities/insert-items-at-target.ts

@@ -0,0 +1,30 @@
+import { ItemInstance } from "../types/core";
+import { DropTarget } from "../features/drag-and-drop/types";
+
+export const insertItemsAtTarget = <T>(
+  itemIds: string[],
+  target: DropTarget<T>,
+  onChangeChildren: (item: ItemInstance<T>, newChildrenIds: string[]) => void
+) => {
+  // add moved items to new common parent, if dropped onto parent
+  if (target.childIndex === null) {
+    onChangeChildren(target.item, [
+      ...target.item.getChildren().map((item) => item.getId()),
+      ...itemIds,
+    ]);
+    // TODO items[0].getTree().rebuildTree();
+    return;
+  }
+
+  // add moved items to new common parent, if dropped between siblings
+  const oldChildren = target.item.getChildren();
+  const newChildren = [
+    ...oldChildren.slice(0, target.insertionIndex).map((item) => item.getId()),
+    ...itemIds,
+    ...oldChildren.slice(target.insertionIndex).map((item) => item.getId()),
+  ];
+
+  onChangeChildren(target.item, newChildren);
+
+  target.item.getTree().rebuildTree();
+};

package/src/utilities/remove-items-from-parents.ts

@@ -0,0 +1,21 @@
+import { ItemInstance } from "../types/core";
+
+export const removeItemsFromParents = <T>(
+  movedItems: ItemInstance<T>[],
+  onChangeChildren: (item: ItemInstance<T>, newChildrenIds: string[]) => void
+) => {
+  // TODO bulk sibling changes together
+  for (const item of movedItems) {
+    const siblings = item.getParent()?.getChildren();
+    if (siblings) {
+      onChangeChildren(
+        item.getParent(),
+        siblings
+          .filter((sibling) => sibling.getId() !== item.getId())
+          .map((i) => i.getId())
+      );
+    }
+  }
+
+  movedItems[0].getTree().rebuildTree();
+};

package/src/utils.ts

@@ -1,5 +1,4 @@
-import { ItemInstance, TreeState, Updater } from "./types/core";
-import { DropTarget } from "./features/drag-and-drop/types";
+import { TreeState, Updater } from "./types/core";
 
 export type NoInfer<T> = [T][T extends any ? 0 : never];
 
@@ -53,73 +52,6 @@ export function makeStateUpdater<K extends keyof TreeState<any>>(
   };
 }
 
-export const scrollIntoView = (element: Element | undefined | null) => {
-  if (!element) {
-    return;
-  }
-
-  if ((element as any).scrollIntoViewIfNeeded) {
-    (element as any).scrollIntoViewIfNeeded();
-  } else {
-    const boundingBox = element.getBoundingClientRect();
-    const isElementInViewport =
-      boundingBox.top >= 0 &&
-      boundingBox.left >= 0 &&
-      boundingBox.bottom <=
-        (window.innerHeight || document.documentElement.clientHeight) &&
-      boundingBox.right <=
-        (window.innerWidth || document.documentElement.clientWidth);
-    if (!isElementInViewport) {
-      element.scrollIntoView();
-    }
-  }
-};
-
-export const performItemsMove = <T>(
-  items: ItemInstance<T>[],
-  target: DropTarget<T>,
-  onChangeChildren: (
-    item: ItemInstance<T>,
-    newChildren: ItemInstance<T>[]
-  ) => void
-) => {
-  const numberOfDragItemsBeforeTarget = !target.childIndex
-    ? 0
-    : target.item
-        .getChildren()
-        .slice(0, target.childIndex)
-        .filter((child) => items.some((item) => item.getId() === child.getId()))
-        .length;
-
-  // TODO bulk sibling changes together
-  for (const item of items) {
-    const siblings = item.getParent()?.getChildren();
-    if (siblings) {
-      onChangeChildren(
-        item.getParent(),
-        siblings.filter((sibling) => sibling.getId() !== item.getId())
-      );
-    }
-  }
-
-  if (target.childIndex === null) {
-    onChangeChildren(target.item, [...target.item.getChildren(), ...items]);
-    items[0].getTree().rebuildTree();
-    return;
-  }
-
-  const oldChildren = target.item.getChildren();
-  const newChildren = [
-    ...oldChildren.slice(0, target.childIndex - numberOfDragItemsBeforeTarget),
-    ...items,
-    ...oldChildren.slice(target.childIndex - numberOfDragItemsBeforeTarget),
-  ];
-
-  onChangeChildren(target.item, newChildren);
-
-  items[0].getTree().rebuildTree();
-};
-
 export const poll = (fn: () => boolean, interval = 100, timeout = 1000) =>
   new Promise<void>((resolve) => {
     let clear: ReturnType<typeof setTimeout>;

package/lib/cjs/data-adapters/nested-data-adapter.d.ts

@@ -1,9 +0,0 @@
-import { DataAdapterConfig } from "./types";
-interface NestedDataAdapterProps<T> {
-    rootItem: T;
-    getItemId: (item: T) => string;
-    getChildren: (item: T) => T[] | undefined;
-    changeChildren?: (item: T, children: T[]) => void;
-}
-export declare const nestedDataAdapter: <T = any>(props: NestedDataAdapterProps<T>) => DataAdapterConfig<T>;
-export {};

package/lib/cjs/data-adapters/nested-data-adapter.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.nestedDataAdapter = void 0;
-const utils_1 = require("../utils");
-const createItemMap = (props, item, map = {}) => {
-    var _a;
-    map[props.getItemId(item)] = item;
-    (_a = props.getChildren(item)) === null || _a === void 0 ? void 0 : _a.forEach((child) => {
-        createItemMap(props, child, map);
-    });
-    return map;
-};
-const nestedDataAdapter = (props) => {
-    const itemMap = createItemMap(props, props.rootItem);
-    return {
-        rootItemId: props.getItemId(props.rootItem),
-        dataLoader: {
-            getItem: (itemId) => itemMap[itemId],
-            getChildren: (itemId) => { var _a, _b; return (_b = (_a = props.getChildren(itemMap[itemId])) === null || _a === void 0 ? void 0 : _a.map(props.getItemId)) !== null && _b !== void 0 ? _b : []; },
-        },
-        onDrop: (items, target) => {
-            if (!props.changeChildren) {
-                return;
-            }
-            (0, utils_1.performItemsMove)(items, target, (item, newChildren) => {
-                var _a;
-                (_a = props.changeChildren) === null || _a === void 0 ? void 0 : _a.call(props, item.getItemData(), newChildren.map((child) => child.getItemData()));
-            });
-        },
-    };
-};
-exports.nestedDataAdapter = nestedDataAdapter;

package/lib/cjs/data-adapters/types.d.ts

@@ -1,7 +0,0 @@
-import { DragAndDropFeatureDef } from "../features/drag-and-drop/types";
-import { SyncDataLoaderFeatureDef } from "../features/sync-data-loader/types";
-export type DataAdapterConfig<T> = {
-    rootItemId: SyncDataLoaderFeatureDef<T>["config"]["rootItemId"];
-    dataLoader: SyncDataLoaderFeatureDef<T>["config"]["dataLoader"];
-    onDrop: DragAndDropFeatureDef<T>["config"]["onDrop"];
-};

package/lib/cjs/data-adapters/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/esm/data-adapters/nested-data-adapter.d.ts

@@ -1,9 +0,0 @@
-import { DataAdapterConfig } from "./types";
-interface NestedDataAdapterProps<T> {
-    rootItem: T;
-    getItemId: (item: T) => string;
-    getChildren: (item: T) => T[] | undefined;
-    changeChildren?: (item: T, children: T[]) => void;
-}
-export declare const nestedDataAdapter: <T = any>(props: NestedDataAdapterProps<T>) => DataAdapterConfig<T>;
-export {};

package/lib/esm/data-adapters/nested-data-adapter.js

@@ -1,28 +0,0 @@
-import { performItemsMove } from "../utils";
-const createItemMap = (props, item, map = {}) => {
-    var _a;
-    map[props.getItemId(item)] = item;
-    (_a = props.getChildren(item)) === null || _a === void 0 ? void 0 : _a.forEach((child) => {
-        createItemMap(props, child, map);
-    });
-    return map;
-};
-export const nestedDataAdapter = (props) => {
-    const itemMap = createItemMap(props, props.rootItem);
-    return {
-        rootItemId: props.getItemId(props.rootItem),
-        dataLoader: {
-            getItem: (itemId) => itemMap[itemId],
-            getChildren: (itemId) => { var _a, _b; return (_b = (_a = props.getChildren(itemMap[itemId])) === null || _a === void 0 ? void 0 : _a.map(props.getItemId)) !== null && _b !== void 0 ? _b : []; },
-        },
-        onDrop: (items, target) => {
-            if (!props.changeChildren) {
-                return;
-            }
-            performItemsMove(items, target, (item, newChildren) => {
-                var _a;
-                (_a = props.changeChildren) === null || _a === void 0 ? void 0 : _a.call(props, item.getItemData(), newChildren.map((child) => child.getItemData()));
-            });
-        },
-    };
-};

package/lib/esm/data-adapters/types.d.ts

@@ -1,7 +0,0 @@
-import { DragAndDropFeatureDef } from "../features/drag-and-drop/types";
-import { SyncDataLoaderFeatureDef } from "../features/sync-data-loader/types";
-export type DataAdapterConfig<T> = {
-    rootItemId: SyncDataLoaderFeatureDef<T>["config"]["rootItemId"];
-    dataLoader: SyncDataLoaderFeatureDef<T>["config"]["dataLoader"];
-    onDrop: DragAndDropFeatureDef<T>["config"]["onDrop"];
-};

package/lib/esm/data-adapters/types.js

@@ -1 +0,0 @@
-export {};

package/src/data-adapters/nested-data-adapter.ts

@@ -1,48 +0,0 @@
-import { DataAdapterConfig } from "./types";
-import { ItemInstance } from "../types/core";
-import { DropTarget } from "../features/drag-and-drop/types";
-import { performItemsMove } from "../utils";
-
-interface NestedDataAdapterProps<T> {
-  rootItem: T;
-  getItemId: (item: T) => string;
-  getChildren: (item: T) => T[] | undefined;
-  changeChildren?: (item: T, children: T[]) => void;
-}
-
-const createItemMap = <T>(
-  props: NestedDataAdapterProps<T>,
-  item: T,
-  map: Record<string, T> = {}
-) => {
-  map[props.getItemId(item)] = item;
-  props.getChildren(item)?.forEach((child) => {
-    createItemMap(props, child, map);
-  });
-  return map;
-};
-
-export const nestedDataAdapter = <T = any>(
-  props: NestedDataAdapterProps<T>
-): DataAdapterConfig<T> => {
-  const itemMap = createItemMap(props, props.rootItem);
-  return {
-    rootItemId: props.getItemId(props.rootItem),
-    dataLoader: {
-      getItem: (itemId) => itemMap[itemId],
-      getChildren: (itemId) =>
-        props.getChildren(itemMap[itemId])?.map(props.getItemId) ?? [],
-    },
-    onDrop: (items: ItemInstance<T>[], target: DropTarget<T>) => {
-      if (!props.changeChildren) {
-        return;
-      }
-      performItemsMove(items, target, (item, newChildren) => {
-        props.changeChildren?.(
-          item.getItemData(),
-          newChildren.map((child) => child.getItemData())
-        );
-      });
-    },
-  };
-};

package/src/data-adapters/types.ts

@@ -1,9 +0,0 @@
-import { DragAndDropFeatureDef } from "../features/drag-and-drop/types";
-import { SyncDataLoaderFeatureDef } from "../features/sync-data-loader/types";
-
-export type DataAdapterConfig<T> = {
-  rootItemId: SyncDataLoaderFeatureDef<T>["config"]["rootItemId"];
-  dataLoader: SyncDataLoaderFeatureDef<T>["config"]["dataLoader"];
-  onDrop: DragAndDropFeatureDef<T>["config"]["onDrop"];
-  // TODO onDropForeignDragObject: DragAndDropFeatureDef<T>["config"]["onDropForeignDragObject"];
-};