@headless-tree/core 0.0.14 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (125) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/lib/cjs/core/create-tree.js +13 -4
  3. package/lib/cjs/features/async-data-loader/feature.js +73 -48
  4. package/lib/cjs/features/async-data-loader/types.d.ts +17 -14
  5. package/lib/cjs/features/drag-and-drop/feature.js +98 -93
  6. package/lib/cjs/features/drag-and-drop/types.d.ts +17 -29
  7. package/lib/cjs/features/drag-and-drop/types.js +7 -7
  8. package/lib/cjs/features/drag-and-drop/utils.d.ts +25 -3
  9. package/lib/cjs/features/drag-and-drop/utils.js +51 -51
  10. package/lib/cjs/features/expand-all/feature.js +26 -3
  11. package/lib/cjs/features/expand-all/types.d.ts +3 -1
  12. package/lib/cjs/features/hotkeys-core/feature.js +7 -3
  13. package/lib/cjs/features/hotkeys-core/types.d.ts +4 -5
  14. package/lib/cjs/features/keyboard-drag-and-drop/feature.d.ts +2 -0
  15. package/lib/cjs/features/keyboard-drag-and-drop/feature.js +206 -0
  16. package/lib/cjs/features/keyboard-drag-and-drop/types.d.ts +27 -0
  17. package/lib/cjs/features/keyboard-drag-and-drop/types.js +11 -0
  18. package/lib/cjs/features/prop-memoization/feature.js +33 -11
  19. package/lib/cjs/features/prop-memoization/types.d.ts +8 -3
  20. package/lib/cjs/features/renaming/feature.js +1 -1
  21. package/lib/cjs/features/search/feature.js +2 -0
  22. package/lib/cjs/features/search/types.d.ts +2 -2
  23. package/lib/cjs/features/selection/feature.js +4 -4
  24. package/lib/cjs/features/selection/types.d.ts +1 -1
  25. package/lib/cjs/features/sync-data-loader/feature.js +31 -5
  26. package/lib/cjs/features/sync-data-loader/types.d.ts +5 -5
  27. package/lib/cjs/features/tree/feature.js +4 -9
  28. package/lib/cjs/features/tree/types.d.ts +7 -5
  29. package/lib/cjs/index.d.ts +2 -0
  30. package/lib/cjs/index.js +2 -0
  31. package/lib/cjs/mddocs-entry.d.ts +10 -0
  32. package/lib/cjs/test-utils/test-tree-do.d.ts +2 -2
  33. package/lib/cjs/test-utils/test-tree-do.js +19 -6
  34. package/lib/cjs/test-utils/test-tree-expect.d.ts +5 -3
  35. package/lib/cjs/test-utils/test-tree-expect.js +3 -0
  36. package/lib/cjs/test-utils/test-tree.d.ts +2 -1
  37. package/lib/cjs/test-utils/test-tree.js +24 -21
  38. package/lib/cjs/types/core.d.ts +2 -1
  39. package/lib/cjs/utilities/create-on-drop-handler.d.ts +2 -2
  40. package/lib/cjs/utilities/create-on-drop-handler.js +13 -4
  41. package/lib/cjs/utilities/insert-items-at-target.d.ts +2 -2
  42. package/lib/cjs/utilities/insert-items-at-target.js +21 -12
  43. package/lib/cjs/utilities/remove-items-from-parents.d.ts +1 -1
  44. package/lib/cjs/utilities/remove-items-from-parents.js +12 -3
  45. package/lib/esm/core/create-tree.js +13 -4
  46. package/lib/esm/features/async-data-loader/feature.js +73 -48
  47. package/lib/esm/features/async-data-loader/types.d.ts +17 -14
  48. package/lib/esm/features/drag-and-drop/feature.js +99 -94
  49. package/lib/esm/features/drag-and-drop/types.d.ts +17 -29
  50. package/lib/esm/features/drag-and-drop/types.js +6 -6
  51. package/lib/esm/features/drag-and-drop/utils.d.ts +25 -3
  52. package/lib/esm/features/drag-and-drop/utils.js +45 -49
  53. package/lib/esm/features/expand-all/feature.js +26 -3
  54. package/lib/esm/features/expand-all/types.d.ts +3 -1
  55. package/lib/esm/features/hotkeys-core/feature.js +7 -3
  56. package/lib/esm/features/hotkeys-core/types.d.ts +4 -5
  57. package/lib/esm/features/keyboard-drag-and-drop/feature.d.ts +2 -0
  58. package/lib/esm/features/keyboard-drag-and-drop/feature.js +203 -0
  59. package/lib/esm/features/keyboard-drag-and-drop/types.d.ts +27 -0
  60. package/lib/esm/features/keyboard-drag-and-drop/types.js +8 -0
  61. package/lib/esm/features/prop-memoization/feature.js +33 -11
  62. package/lib/esm/features/prop-memoization/types.d.ts +8 -3
  63. package/lib/esm/features/renaming/feature.js +1 -1
  64. package/lib/esm/features/search/feature.js +2 -0
  65. package/lib/esm/features/search/types.d.ts +2 -2
  66. package/lib/esm/features/selection/feature.js +4 -4
  67. package/lib/esm/features/selection/types.d.ts +1 -1
  68. package/lib/esm/features/sync-data-loader/feature.js +31 -5
  69. package/lib/esm/features/sync-data-loader/types.d.ts +5 -5
  70. package/lib/esm/features/tree/feature.js +4 -9
  71. package/lib/esm/features/tree/types.d.ts +7 -5
  72. package/lib/esm/index.d.ts +2 -0
  73. package/lib/esm/index.js +2 -0
  74. package/lib/esm/mddocs-entry.d.ts +10 -0
  75. package/lib/esm/test-utils/test-tree-do.d.ts +2 -2
  76. package/lib/esm/test-utils/test-tree-do.js +19 -6
  77. package/lib/esm/test-utils/test-tree-expect.d.ts +5 -3
  78. package/lib/esm/test-utils/test-tree-expect.js +3 -0
  79. package/lib/esm/test-utils/test-tree.d.ts +2 -1
  80. package/lib/esm/test-utils/test-tree.js +24 -21
  81. package/lib/esm/types/core.d.ts +2 -1
  82. package/lib/esm/utilities/create-on-drop-handler.d.ts +2 -2
  83. package/lib/esm/utilities/create-on-drop-handler.js +13 -4
  84. package/lib/esm/utilities/insert-items-at-target.d.ts +2 -2
  85. package/lib/esm/utilities/insert-items-at-target.js +21 -12
  86. package/lib/esm/utilities/remove-items-from-parents.d.ts +1 -1
  87. package/lib/esm/utilities/remove-items-from-parents.js +12 -3
  88. package/package.json +2 -2
  89. package/src/core/core.spec.ts +31 -0
  90. package/src/core/create-tree.ts +15 -5
  91. package/src/features/async-data-loader/async-data-loader.spec.ts +10 -6
  92. package/src/features/async-data-loader/feature.ts +76 -48
  93. package/src/features/async-data-loader/types.ts +18 -11
  94. package/src/features/drag-and-drop/drag-and-drop.spec.ts +75 -89
  95. package/src/features/drag-and-drop/feature.ts +26 -22
  96. package/src/features/drag-and-drop/types.ts +23 -35
  97. package/src/features/drag-and-drop/utils.ts +70 -57
  98. package/src/features/expand-all/feature.ts +29 -5
  99. package/src/features/expand-all/types.ts +3 -1
  100. package/src/features/hotkeys-core/feature.ts +4 -0
  101. package/src/features/hotkeys-core/types.ts +4 -13
  102. package/src/features/keyboard-drag-and-drop/feature.ts +255 -0
  103. package/src/features/keyboard-drag-and-drop/keyboard-drag-and-drop.spec.ts +402 -0
  104. package/src/features/keyboard-drag-and-drop/types.ts +30 -0
  105. package/src/features/prop-memoization/feature.ts +27 -8
  106. package/src/features/prop-memoization/prop-memoization.spec.ts +2 -2
  107. package/src/features/prop-memoization/types.ts +8 -3
  108. package/src/features/renaming/feature.ts +8 -2
  109. package/src/features/search/feature.ts +2 -0
  110. package/src/features/search/types.ts +2 -2
  111. package/src/features/selection/feature.ts +4 -4
  112. package/src/features/selection/types.ts +1 -1
  113. package/src/features/sync-data-loader/feature.ts +26 -7
  114. package/src/features/sync-data-loader/types.ts +5 -5
  115. package/src/features/tree/feature.ts +8 -13
  116. package/src/features/tree/types.ts +7 -5
  117. package/src/index.ts +2 -0
  118. package/src/mddocs-entry.ts +16 -0
  119. package/src/test-utils/test-tree-do.ts +3 -3
  120. package/src/test-utils/test-tree-expect.ts +7 -2
  121. package/src/test-utils/test-tree.ts +26 -22
  122. package/src/types/core.ts +2 -0
  123. package/src/utilities/create-on-drop-handler.ts +4 -4
  124. package/src/utilities/insert-items-at-target.ts +18 -14
  125. package/src/utilities/remove-items-from-parents.ts +6 -3
@@ -0,0 +1,27 @@
1
+ import { ItemInstance, SetStateFn } from "../../types/core";
2
+ export interface KDndDataRef {
3
+ kDndDataTransfer: DataTransfer | undefined;
4
+ }
5
+ export declare enum AssistiveDndState {
6
+ None = 0,
7
+ Started = 1,
8
+ Dragging = 2,
9
+ Completed = 3,
10
+ Aborted = 4
11
+ }
12
+ export type KeyboardDragAndDropFeatureDef<T> = {
13
+ state: {
14
+ assistiveDndState?: AssistiveDndState | null;
15
+ };
16
+ config: {
17
+ setAssistiveDndState?: SetStateFn<AssistiveDndState | undefined | null>;
18
+ onStartKeyboardDrag?: (items: ItemInstance<T>[]) => void;
19
+ };
20
+ treeInstance: {
21
+ startKeyboardDrag: (items: ItemInstance<T>[]) => void;
22
+ startKeyboardDragOnForeignObject: (dataTransfer: DataTransfer) => void;
23
+ stopKeyboardDrag: () => void;
24
+ };
25
+ itemInstance: {};
26
+ hotkeys: "startDrag" | "cancelDrag" | "completeDrag" | "dragUp" | "dragDown";
27
+ };
@@ -0,0 +1,8 @@
1
+ export var AssistiveDndState;
2
+ (function (AssistiveDndState) {
3
+ AssistiveDndState[AssistiveDndState["None"] = 0] = "None";
4
+ AssistiveDndState[AssistiveDndState["Started"] = 1] = "Started";
5
+ AssistiveDndState[AssistiveDndState["Dragging"] = 2] = "Dragging";
6
+ AssistiveDndState[AssistiveDndState["Completed"] = 3] = "Completed";
7
+ AssistiveDndState[AssistiveDndState["Aborted"] = 4] = "Aborted";
8
+ })(AssistiveDndState || (AssistiveDndState = {}));
@@ -1,13 +1,11 @@
1
- const memoize = (props, dataRef) => {
2
- var _a;
3
- (_a = dataRef.memoizedProps) !== null && _a !== void 0 ? _a : (dataRef.memoizedProps = {});
1
+ const memoize = (props, memoizedProps) => {
4
2
  for (const key in props) {
5
3
  if (typeof props[key] === "function") {
6
- if (key in dataRef.memoizedProps) {
7
- props[key] = dataRef.memoizedProps[key];
4
+ if (memoizedProps && key in memoizedProps) {
5
+ props[key] = memoizedProps[key];
8
6
  }
9
7
  else {
10
- dataRef.memoizedProps[key] = props[key];
8
+ memoizedProps[key] = props[key];
11
9
  }
12
10
  }
13
11
  }
@@ -27,19 +25,43 @@ export const propMemoizationFeature = {
27
25
  "selection",
28
26
  ],
29
27
  treeInstance: {
30
- getContainerProps: ({ tree, prev }) => {
31
- var _a;
28
+ getContainerProps: ({ tree, prev }, treeLabel) => {
29
+ var _a, _b, _c;
30
+ var _d, _e;
31
+ const dataRef = tree.getDataRef();
32
+ const props = (_a = prev === null || prev === void 0 ? void 0 : prev(treeLabel)) !== null && _a !== void 0 ? _a : {};
33
+ (_b = (_d = dataRef.current).memo) !== null && _b !== void 0 ? _b : (_d.memo = {});
34
+ (_c = (_e = dataRef.current.memo).tree) !== null && _c !== void 0 ? _c : (_e.tree = {});
35
+ return memoize(props, dataRef.current.memo.tree);
36
+ },
37
+ getSearchInputElementProps: ({ tree, prev }) => {
38
+ var _a, _b, _c;
39
+ var _d, _e;
32
40
  const dataRef = tree.getDataRef();
33
41
  const props = (_a = prev === null || prev === void 0 ? void 0 : prev()) !== null && _a !== void 0 ? _a : {};
34
- return memoize(props, dataRef.current);
42
+ (_b = (_d = dataRef.current).memo) !== null && _b !== void 0 ? _b : (_d.memo = {});
43
+ (_c = (_e = dataRef.current.memo).search) !== null && _c !== void 0 ? _c : (_e.search = {});
44
+ return memoize(props, dataRef.current.memo.search);
35
45
  },
36
46
  },
37
47
  itemInstance: {
38
48
  getProps: ({ item, prev }) => {
39
- var _a;
49
+ var _a, _b, _c;
50
+ var _d, _e;
51
+ const dataRef = item.getDataRef();
52
+ const props = (_a = prev === null || prev === void 0 ? void 0 : prev()) !== null && _a !== void 0 ? _a : {};
53
+ (_b = (_d = dataRef.current).memo) !== null && _b !== void 0 ? _b : (_d.memo = {});
54
+ (_c = (_e = dataRef.current.memo).item) !== null && _c !== void 0 ? _c : (_e.item = {});
55
+ return memoize(props, dataRef.current.memo.item);
56
+ },
57
+ getRenameInputProps: ({ item, prev }) => {
58
+ var _a, _b, _c;
59
+ var _d, _e;
40
60
  const dataRef = item.getDataRef();
41
61
  const props = (_a = prev === null || prev === void 0 ? void 0 : prev()) !== null && _a !== void 0 ? _a : {};
42
- return memoize(props, dataRef.current);
62
+ (_b = (_d = dataRef.current).memo) !== null && _b !== void 0 ? _b : (_d.memo = {});
63
+ (_c = (_e = dataRef.current.memo).rename) !== null && _c !== void 0 ? _c : (_e.rename = {});
64
+ return memoize(props, dataRef.current.memo.rename);
43
65
  },
44
66
  },
45
67
  };
@@ -1,6 +1,11 @@
1
- export type PropMemoizationDataRef = {
2
- memoizedProps?: Record<string, any>;
3
- };
1
+ export interface PropMemoizationDataRef {
2
+ memo?: {
3
+ tree?: Record<string, any>;
4
+ item?: Record<string, any>;
5
+ search?: Record<string, any>;
6
+ rename?: Record<string, any>;
7
+ };
8
+ }
4
9
  export type PropMemoizationFeatureDef = {
5
10
  state: {};
6
11
  config: {};
@@ -37,11 +37,11 @@ export const renamingFeature = {
37
37
  tree.applySubStateUpdate("renamingValue", item.getItemName());
38
38
  },
39
39
  getRenameInputProps: ({ tree }) => ({
40
+ ref: (r) => r === null || r === void 0 ? void 0 : r.focus(),
40
41
  onBlur: () => tree.abortRenaming(),
41
42
  value: tree.getRenamingValue(),
42
43
  onChange: (e) => {
43
44
  var _a;
44
- // TODO custom type with e.target.value
45
45
  tree.applySubStateUpdate("renamingValue", (_a = e.target) === null || _a === void 0 ? void 0 : _a.value);
46
46
  },
47
47
  }),
@@ -40,10 +40,12 @@ export const searchFeature = {
40
40
  }
41
41
  },
42
42
  getSearchInputElement: ({ tree }) => { var _a; return (_a = tree.getDataRef().current.searchInput) !== null && _a !== void 0 ? _a : null; },
43
+ // TODO memoize with propMemoizationFeature
43
44
  getSearchInputElementProps: ({ tree }) => ({
44
45
  value: tree.getSearchValue(),
45
46
  onChange: (e) => tree.setSearch(e.target.value),
46
47
  onBlur: () => tree.closeSearch(),
48
+ ref: tree.registerSearchInputElement,
47
49
  }),
48
50
  getSearchMatchingItems: memo(({ tree }) => [
49
51
  tree.getSearchValue(),
@@ -1,9 +1,9 @@
1
1
  import { ItemInstance, SetStateFn } from "../../types/core";
2
2
  import { HotkeysCoreDataRef } from "../hotkeys-core/types";
3
- export type SearchFeatureDataRef<T = any> = HotkeysCoreDataRef & {
3
+ export interface SearchFeatureDataRef<T = any> extends HotkeysCoreDataRef {
4
4
  matchingItems: ItemInstance<T>[];
5
5
  searchInput: HTMLInputElement | null;
6
- };
6
+ }
7
7
  export type SearchFeatureDef<T> = {
8
8
  state: {
9
9
  search: string | null;
@@ -10,7 +10,6 @@ export const selectionFeature = {
10
10
  setSelectedItems: ({ tree }, selectedItems) => {
11
11
  tree.applySubStateUpdate("selectedItems", selectedItems);
12
12
  },
13
- // TODO memo
14
13
  getSelectedItems: ({ tree }) => {
15
14
  return tree.getState().selectedItems.map(tree.getItemInstance);
16
15
  },
@@ -78,9 +77,10 @@ export const selectionFeature = {
78
77
  // tree.setSelectedItems([tree.getFocusedItem().getId()]);
79
78
  // },
80
79
  // },
81
- toggleSelectItem: {
82
- hotkey: "ctrl+space",
83
- handler: (e, tree) => {
80
+ toggleSelectedItem: {
81
+ hotkey: "Control+Space",
82
+ preventDefault: true,
83
+ handler: (_, tree) => {
84
84
  tree.getFocusedItem().toggleSelect();
85
85
  },
86
86
  },
@@ -17,5 +17,5 @@ export type SelectionFeatureDef<T> = {
17
17
  isSelected: () => boolean;
18
18
  selectUpTo: (ctrl: boolean) => void;
19
19
  };
20
- hotkeys: "toggleSelectItem" | "selectUpwards" | "selectDownwards" | "selectAll";
20
+ hotkeys: "toggleSelectedItem" | "selectUpwards" | "selectDownwards" | "selectAll";
21
21
  };
@@ -1,14 +1,40 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
1
10
  import { makeStateUpdater } from "../../utils";
11
+ import { throwError } from "../../utilities/errors";
12
+ const promiseErrorMessage = "sync dataLoader returned promise";
2
13
  export const syncDataLoaderFeature = {
3
14
  key: "sync-data-loader",
4
- getInitialState: (initialState) => (Object.assign({ loadingItems: [] }, initialState)),
5
- getDefaultConfig: (defaultConfig, tree) => (Object.assign({ setLoadingItems: makeStateUpdater("loadingItems", tree) }, defaultConfig)),
15
+ getInitialState: (initialState) => (Object.assign({ loadingItemData: [], loadingItemChildrens: [] }, initialState)),
16
+ getDefaultConfig: (defaultConfig, tree) => (Object.assign({ setLoadingItemData: makeStateUpdater("loadingItemData", tree), setLoadingItemChildrens: makeStateUpdater("loadingItemChildrens", tree) }, defaultConfig)),
6
17
  stateHandlerNames: {
7
- loadingItems: "setLoadingItems",
18
+ loadingItemData: "setLoadingItemData",
19
+ loadingItemChildrens: "setLoadingItemChildrens",
8
20
  },
9
21
  treeInstance: {
10
- retrieveItemData: ({ tree }, itemId) => tree.getConfig().dataLoader.getItem(itemId),
11
- retrieveChildrenIds: ({ tree }, itemId) => tree.getConfig().dataLoader.getChildren(itemId),
22
+ waitForItemDataLoaded: () => __awaiter(void 0, void 0, void 0, function* () { }),
23
+ waitForItemChildrenLoaded: () => __awaiter(void 0, void 0, void 0, function* () { }),
24
+ retrieveItemData: ({ tree }, itemId) => {
25
+ const data = tree.getConfig().dataLoader.getItem(itemId);
26
+ if (typeof data === "object" && "then" in data) {
27
+ throw throwError(promiseErrorMessage);
28
+ }
29
+ return data;
30
+ },
31
+ retrieveChildrenIds: ({ tree }, itemId) => {
32
+ const data = tree.getConfig().dataLoader.getChildren(itemId);
33
+ if (typeof data === "object" && "then" in data) {
34
+ throw throwError(promiseErrorMessage);
35
+ }
36
+ return data;
37
+ },
12
38
  },
13
39
  itemInstance: {
14
40
  isLoading: () => false,
@@ -1,12 +1,12 @@
1
- export type SyncTreeDataLoader<T> = {
2
- getItem: (itemId: string) => T;
3
- getChildren: (itemId: string) => string[];
4
- };
1
+ export interface TreeDataLoader<T> {
2
+ getItem: (itemId: string) => T | Promise<T>;
3
+ getChildren: (itemId: string) => string[] | Promise<string[]>;
4
+ }
5
5
  export type SyncDataLoaderFeatureDef<T> = {
6
6
  state: {};
7
7
  config: {
8
8
  rootItemId: string;
9
- dataLoader?: SyncTreeDataLoader<T>;
9
+ dataLoader: TreeDataLoader<T>;
10
10
  };
11
11
  treeInstance: {
12
12
  retrieveItemData: (itemId: string) => T;
@@ -21,7 +21,7 @@ export const treeFeature = {
21
21
  const { rootItemId } = tree.getConfig();
22
22
  const { expandedItems } = tree.getState();
23
23
  const flatItems = [];
24
- const expandedItemsSet = new Set(expandedItems);
24
+ const expandedItemsSet = new Set(expandedItems); // TODO support setting state expandedItems as set instead of array
25
25
  const recursiveAdd = (itemId, parentId, level, setSize, posInSet) => {
26
26
  var _a;
27
27
  flatItems.push({
@@ -33,7 +33,6 @@ export const treeFeature = {
33
33
  posInSet,
34
34
  });
35
35
  if (expandedItemsSet.has(itemId)) {
36
- // TODO THIS MADE A HUGE DIFFERENCE!
37
36
  const children = (_a = tree.retrieveChildrenIds(itemId)) !== null && _a !== void 0 ? _a : [];
38
37
  let i = 0;
39
38
  for (const childId of children) {
@@ -48,7 +47,6 @@ export const treeFeature = {
48
47
  }
49
48
  return flatItems;
50
49
  },
51
- // TODO memo
52
50
  getFocusedItem: ({ tree }) => {
53
51
  var _a, _b;
54
52
  return ((_b = tree.getItemInstance((_a = tree.getState().focusedItem) !== null && _a !== void 0 ? _a : "")) !== null && _b !== void 0 ? _b : tree.getItems()[0]);
@@ -78,8 +76,7 @@ export const treeFeature = {
78
76
  focusedElement.focus();
79
77
  }));
80
78
  },
81
- // TODO add label parameter
82
- getContainerProps: ({ prev, tree }) => (Object.assign(Object.assign({}, prev === null || prev === void 0 ? void 0 : prev()), { role: "tree", "aria-label": "", ref: tree.registerElement })),
79
+ getContainerProps: ({ prev, tree }, treeLabel) => (Object.assign(Object.assign({}, prev === null || prev === void 0 ? void 0 : prev()), { role: "tree", "aria-label": treeLabel !== null && treeLabel !== void 0 ? treeLabel : "", ref: tree.registerElement })),
83
80
  // relevant for hotkeys of this feature
84
81
  isSearchOpen: () => false,
85
82
  },
@@ -115,7 +112,7 @@ export const treeFeature = {
115
112
  if (!item.isFolder()) {
116
113
  return;
117
114
  }
118
- if ((_a = tree.getState().loadingItems) === null || _a === void 0 ? void 0 : _a.includes(itemId)) {
115
+ if ((_a = tree.getState().loadingItemChildrens) === null || _a === void 0 ? void 0 : _a.includes(itemId)) {
119
116
  return;
120
117
  }
121
118
  tree.applySubStateUpdate("expandedItems", (expandedItems) => [
@@ -154,9 +151,7 @@ export const treeFeature = {
154
151
  ? tree.getItemInstance(item.getItemMeta().parentId)
155
152
  : undefined,
156
153
  getIndexInParent: ({ item }) => item.getItemMeta().posInSet,
157
- getChildren: ({ tree, item }) => tree
158
- .retrieveChildrenIds(item.getItemMeta().itemId)
159
- .map((id) => tree.getItemInstance(id)),
154
+ getChildren: ({ tree, itemId }) => tree.retrieveChildrenIds(itemId).map((id) => tree.getItemInstance(id)),
160
155
  getTree: ({ tree }) => tree,
161
156
  getItemAbove: ({ tree, item }) => tree.getItems()[item.getItemMeta().index - 1],
162
157
  getItemBelow: ({ tree, item }) => tree.getItems()[item.getItemMeta().index + 1],
@@ -1,16 +1,16 @@
1
1
  import { ItemInstance, SetStateFn, TreeInstance } from "../../types/core";
2
- export type ItemMeta = {
2
+ export interface ItemMeta {
3
3
  itemId: string;
4
4
  parentId: string;
5
5
  level: number;
6
6
  index: number;
7
7
  setSize: number;
8
8
  posInSet: number;
9
- };
10
- export type TreeItemDataRef = {
9
+ }
10
+ export interface TreeItemDataRef {
11
11
  memoizedValues: Record<string, any>;
12
12
  memoizedDeps: Record<string, any[] | undefined>;
13
- };
13
+ }
14
14
  export type TreeFeatureDef<T> = {
15
15
  state: {
16
16
  expandedItems: string[];
@@ -31,7 +31,9 @@ export type TreeFeatureDef<T> = {
31
31
  focusNextItem: () => void;
32
32
  focusPreviousItem: () => void;
33
33
  updateDomFocus: () => void;
34
- getContainerProps: () => Record<string, any>;
34
+ /** Pass to the container rendering the tree children. The `treeLabel` parameter
35
+ * will be passed as `aria-label` parameter, and is recommended to be set. */
36
+ getContainerProps: (treeLabel?: string) => Record<string, any>;
35
37
  };
36
38
  itemInstance: {
37
39
  getId: () => string;
@@ -3,6 +3,7 @@ export * from "./core/create-tree";
3
3
  export * from "./features/tree/types";
4
4
  export { MainFeatureDef, InstanceBuilder } from "./features/main/types";
5
5
  export * from "./features/drag-and-drop/types";
6
+ export * from "./features/keyboard-drag-and-drop/types";
6
7
  export * from "./features/selection/types";
7
8
  export * from "./features/async-data-loader/types";
8
9
  export * from "./features/sync-data-loader/types";
@@ -16,6 +17,7 @@ export * from "./features/hotkeys-core/feature";
16
17
  export * from "./features/async-data-loader/feature";
17
18
  export * from "./features/sync-data-loader/feature";
18
19
  export * from "./features/drag-and-drop/feature";
20
+ export * from "./features/keyboard-drag-and-drop/feature";
19
21
  export * from "./features/search/feature";
20
22
  export * from "./features/renaming/feature";
21
23
  export * from "./features/expand-all/feature";
package/lib/esm/index.js CHANGED
@@ -2,6 +2,7 @@ export * from "./types/core";
2
2
  export * from "./core/create-tree";
3
3
  export * from "./features/tree/types";
4
4
  export * from "./features/drag-and-drop/types";
5
+ export * from "./features/keyboard-drag-and-drop/types";
5
6
  export * from "./features/selection/types";
6
7
  export * from "./features/async-data-loader/types";
7
8
  export * from "./features/sync-data-loader/types";
@@ -15,6 +16,7 @@ export * from "./features/hotkeys-core/feature";
15
16
  export * from "./features/async-data-loader/feature";
16
17
  export * from "./features/sync-data-loader/feature";
17
18
  export * from "./features/drag-and-drop/feature";
19
+ export * from "./features/keyboard-drag-and-drop/feature";
18
20
  export * from "./features/search/feature";
19
21
  export * from "./features/renaming/feature";
20
22
  export * from "./features/expand-all/feature";
@@ -9,6 +9,7 @@ import { SelectionFeatureDef } from "./features/selection/types";
9
9
  import { SyncDataLoaderFeatureDef } from "./features/sync-data-loader/types";
10
10
  import { TreeFeatureDef } from "./features/tree/types";
11
11
  import { PropMemoizationFeatureDef } from "./features/prop-memoization/types";
12
+ import { KeyboardDragAndDropFeatureDef } from "./features/keyboard-drag-and-drop/types";
12
13
  export * from ".";
13
14
  /** @interface */
14
15
  export type AsyncDataLoaderFeatureConfig<T> = AsyncDataLoaderFeatureDef<T>["config"];
@@ -29,6 +30,15 @@ export type DragAndDropFeatureTreeInstance<T> = DragAndDropFeatureDef<T>["treeIn
29
30
  export type DragAndDropFeatureItemInstance<T> = DragAndDropFeatureDef<T>["itemInstance"];
30
31
  export type DragAndDropFeatureHotkeys<T> = DragAndDropFeatureDef<T>["hotkeys"];
31
32
  /** @interface */
33
+ export type KeyboardDragAndDropFeatureConfig<T> = KeyboardDragAndDropFeatureDef<T>["config"];
34
+ /** @interface */
35
+ export type KeyboardDragAndDropFeatureState<T> = KeyboardDragAndDropFeatureDef<T>["state"];
36
+ /** @interface */
37
+ export type KeyboardDragAndDropFeatureTreeInstance<T> = KeyboardDragAndDropFeatureDef<T>["treeInstance"];
38
+ /** @interface */
39
+ export type KeyboardDragAndDropFeatureItemInstance<T> = KeyboardDragAndDropFeatureDef<T>["itemInstance"];
40
+ export type KeyboardDragAndDropFeatureHotkeys<T> = KeyboardDragAndDropFeatureDef<T>["hotkeys"];
41
+ /** @interface */
32
42
  export type ExpandAllFeatureConfig = ExpandAllFeatureDef["config"];
33
43
  /** @interface */
34
44
  export type ExpandAllFeatureState = ExpandAllFeatureDef["state"];
@@ -17,7 +17,7 @@ export declare class TestTreeDo<T> {
17
17
  dragOverNotAllowed(itemId: string, event?: DragEvent): DragEvent<Element>;
18
18
  dragLeave(itemId: string): void;
19
19
  dragEnd(itemId: string, event?: DragEvent): DragEvent<Element>;
20
- drop(itemId: string, event?: DragEvent): DragEvent<Element>;
21
- dragOverAndDrop(itemId: string, event?: DragEvent): DragEvent<Element>;
20
+ drop(itemId: string, event?: DragEvent): Promise<DragEvent<Element>>;
21
+ dragOverAndDrop(itemId: string, event?: DragEvent): Promise<DragEvent<Element>>;
22
22
  private consistentCalls;
23
23
  }
@@ -1,3 +1,12 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
1
10
  import { expect, vi } from "vitest";
2
11
  import { TestTree } from "./test-tree";
3
12
  export class TestTreeDo {
@@ -76,14 +85,18 @@ export class TestTreeDo {
76
85
  return e;
77
86
  }
78
87
  drop(itemId, event) {
79
- const e = event !== null && event !== void 0 ? event : TestTree.dragEvent();
80
- this.itemProps(itemId).onDrop(e);
81
- return e;
88
+ return __awaiter(this, void 0, void 0, function* () {
89
+ const e = event !== null && event !== void 0 ? event : TestTree.dragEvent();
90
+ yield this.itemProps(itemId).onDrop(e);
91
+ return e;
92
+ });
82
93
  }
83
94
  dragOverAndDrop(itemId, event) {
84
- const e = event !== null && event !== void 0 ? event : TestTree.dragEvent();
85
- this.dragOver(itemId, e);
86
- return this.drop(itemId, e);
95
+ return __awaiter(this, void 0, void 0, function* () {
96
+ const e = event !== null && event !== void 0 ? event : TestTree.dragEvent();
97
+ this.dragOver(itemId, e);
98
+ return this.drop(itemId, e);
99
+ });
87
100
  }
88
101
  consistentCalls(fn) {
89
102
  if (!vi.isMockFunction(fn)) {
@@ -1,15 +1,17 @@
1
1
  import { DragEvent } from "react";
2
2
  import { TestTree } from "./test-tree";
3
- import { DropTarget } from "../features/drag-and-drop/types";
3
+ import { DragTarget } from "../features/drag-and-drop/types";
4
+ import { TreeState } from "../types/core";
4
5
  export declare class TestTreeExpect<T> {
5
6
  private tree;
6
- protected itemInstance(itemId: string): import("..").ItemInstance<T>;
7
+ protected itemInstance(itemId: string): import("../types/core").ItemInstance<T>;
7
8
  protected itemProps(itemId: string): Record<string, any>;
8
9
  constructor(tree: TestTree<T>);
9
10
  foldersExpanded(...itemIds: string[]): void;
10
11
  foldersCollapsed(...itemIds: string[]): void;
11
12
  hasChildren(itemId: string, children: string[]): void;
12
- dropped(draggedItems: string[], target: DropTarget<any>): void;
13
+ substate<K extends keyof TreeState<T>>(key: K, value: TreeState<T>[K]): void;
14
+ dropped(draggedItems: string[], target: DragTarget<any>): void;
13
15
  dragOverNotAllowed(itemId: string, event?: DragEvent): DragEvent<Element>;
14
16
  defaultDragLineProps(indent?: number): void;
15
17
  }
@@ -26,6 +26,9 @@ export class TestTreeExpect {
26
26
  const itemChildren = item.getChildren().map((child) => child.getId());
27
27
  expect(itemChildren).toEqual(children);
28
28
  }
29
+ substate(key, value) {
30
+ expect(this.tree.instance.getState()[key]).toEqual(value);
31
+ }
29
32
  dropped(draggedItems, target) {
30
33
  expect(this.tree.instance.getConfig().onDrop).toBeCalledWith(draggedItems.map((id) => this.tree.item(id)), target);
31
34
  }
@@ -8,6 +8,7 @@ export declare class TestTree<T = string> {
8
8
  readonly expect: TestTreeExpect<T>;
9
9
  private treeInstance;
10
10
  private static asyncLoaderResolvers;
11
+ private asyncDataLoaderImp;
11
12
  suits: {
12
13
  sync: () => {
13
14
  tree: TestTree<T>;
@@ -41,7 +42,7 @@ export declare class TestTree<T = string> {
41
42
  reset(): void;
42
43
  debug(): void;
43
44
  setElementBoundingBox(itemId: string, bb?: Partial<DOMRect>): void;
44
- static dragEvent(pageX?: number, pageY?: number): DragEvent;
45
+ static dragEvent(clientX?: number, clientY?: number): DragEvent;
45
46
  createTopDragEvent(indent?: number): DragEvent<Element>;
46
47
  createBottomDragEvent(indent?: number): DragEvent<Element>;
47
48
  }
@@ -39,13 +39,31 @@ export class TestTree {
39
39
  this.do = new TestTreeDo(this);
40
40
  this.expect = new TestTreeExpect(this);
41
41
  this.treeInstance = null;
42
+ this.asyncDataLoaderImp = {
43
+ getItem: (id) => __awaiter(this, void 0, void 0, function* () {
44
+ yield new Promise((r) => {
45
+ r.debugName = `Loading getItem ${id}`;
46
+ TestTree.asyncLoaderResolvers.push(r);
47
+ });
48
+ return id;
49
+ }),
50
+ getChildren: (id) => __awaiter(this, void 0, void 0, function* () {
51
+ yield new Promise((r) => {
52
+ r.debugName = `Loading getChildren ${id}`;
53
+ TestTree.asyncLoaderResolvers.push(r);
54
+ });
55
+ return [`${id}1`, `${id}2`, `${id}3`, `${id}4`];
56
+ }),
57
+ };
42
58
  this.suits = {
43
59
  sync: () => ({
44
60
  tree: this.withFeatures(syncDataLoaderFeature),
45
61
  title: "Synchronous Data Loader",
46
62
  }),
47
63
  async: () => ({
48
- tree: this.withFeatures(asyncDataLoaderFeature),
64
+ tree: this.withFeatures(asyncDataLoaderFeature).with({
65
+ dataLoader: this.asyncDataLoaderImp,
66
+ }),
49
67
  title: "Asynchronous Data Loader",
50
68
  }),
51
69
  proxifiedSync: () => ({
@@ -65,12 +83,12 @@ export class TestTree {
65
83
  static resolveAsyncLoaders() {
66
84
  return __awaiter(this, void 0, void 0, function* () {
67
85
  var _a;
68
- while (TestTree.asyncLoaderResolvers.length) {
86
+ do {
69
87
  (_a = TestTree.asyncLoaderResolvers.shift()) === null || _a === void 0 ? void 0 : _a();
70
88
  yield new Promise((r) => {
71
89
  setTimeout(r);
72
90
  });
73
- }
91
+ } while (TestTree.asyncLoaderResolvers.length);
74
92
  });
75
93
  }
76
94
  resolveAsyncVisibleItems() {
@@ -85,21 +103,6 @@ export class TestTree {
85
103
  return new TestTree(Object.assign({ rootItemId: "x", createLoadingItemData: () => "loading", dataLoader: {
86
104
  getItem: (id) => id,
87
105
  getChildren: (id) => [`${id}1`, `${id}2`, `${id}3`, `${id}4`],
88
- }, asyncDataLoader: {
89
- getItem: (id) => __awaiter(this, void 0, void 0, function* () {
90
- yield new Promise((r) => {
91
- r.debugName = `Loading getItem ${id}`;
92
- TestTree.asyncLoaderResolvers.push(r);
93
- });
94
- return id;
95
- }),
96
- getChildren: (id) => __awaiter(this, void 0, void 0, function* () {
97
- yield new Promise((r) => {
98
- r.debugName = `Loading getChildren ${id}`;
99
- TestTree.asyncLoaderResolvers.push(r);
100
- });
101
- return [`${id}1`, `${id}2`, `${id}3`, `${id}4`];
102
- }),
103
106
  }, getItemName: (item) => item.getItemData(), indent: 20, isItemFolder: (item) => item.getItemMeta().level < 2, initialState: {
104
107
  expandedItems: ["x1", "x11"],
105
108
  }, features: [] }, config));
@@ -176,7 +179,7 @@ export class TestTree {
176
179
  getBoundingClientRect: () => bb,
177
180
  });
178
181
  }
179
- static dragEvent(pageX = 1000, pageY = 0) {
182
+ static dragEvent(clientX = 1000, clientY = 0) {
180
183
  return {
181
184
  preventDefault: vi.fn(),
182
185
  stopPropagation: vi.fn(),
@@ -185,8 +188,8 @@ export class TestTree {
185
188
  getData: vi.fn(),
186
189
  dropEffect: "unchaged-from-test",
187
190
  },
188
- pageX,
189
- pageY,
191
+ clientX,
192
+ clientY,
190
193
  };
191
194
  }
192
195
  createTopDragEvent(indent = 0) {
@@ -9,6 +9,7 @@ import { SearchFeatureDef } from "../features/search/types";
9
9
  import { RenamingFeatureDef } from "../features/renaming/types";
10
10
  import { ExpandAllFeatureDef } from "../features/expand-all/types";
11
11
  import { PropMemoizationFeatureDef } from "../features/prop-memoization/types";
12
+ import { KeyboardDragAndDropFeatureDef } from "../features/keyboard-drag-and-drop/types";
12
13
  export type Updater<T> = T | ((old: T) => T);
13
14
  export type SetStateFn<T> = (updaterOrValue: Updater<T>) => void;
14
15
  export type FeatureDef = {
@@ -33,7 +34,7 @@ type MergedFeatures<F extends FeatureDef> = {
33
34
  itemInstance: UnionToIntersection<F["itemInstance"]>;
34
35
  hotkeys: F["hotkeys"];
35
36
  };
36
- export type RegisteredFeatures<T> = MainFeatureDef<T> | TreeFeatureDef<T> | SelectionFeatureDef<T> | DragAndDropFeatureDef<T> | HotkeysCoreFeatureDef<T> | SyncDataLoaderFeatureDef<T> | AsyncDataLoaderFeatureDef<T> | SearchFeatureDef<T> | RenamingFeatureDef<T> | ExpandAllFeatureDef | PropMemoizationFeatureDef;
37
+ export type RegisteredFeatures<T> = MainFeatureDef<T> | TreeFeatureDef<T> | SelectionFeatureDef<T> | DragAndDropFeatureDef<T> | KeyboardDragAndDropFeatureDef<T> | HotkeysCoreFeatureDef<T> | SyncDataLoaderFeatureDef<T> | AsyncDataLoaderFeatureDef<T> | SearchFeatureDef<T> | RenamingFeatureDef<T> | ExpandAllFeatureDef | PropMemoizationFeatureDef;
37
38
  type TreeStateType<T> = MergedFeatures<RegisteredFeatures<T>>["state"];
38
39
  export interface TreeState<T> extends TreeStateType<T> {
39
40
  }
@@ -1,3 +1,3 @@
1
1
  import { ItemInstance } from "../types/core";
2
- import { DropTarget } from "../features/drag-and-drop/types";
3
- export declare const createOnDropHandler: <T>(onChangeChildren: (item: ItemInstance<T>, newChildren: string[]) => void) => (items: ItemInstance<T>[], target: DropTarget<T>) => void;
2
+ import { DragTarget } from "../features/drag-and-drop/types";
3
+ export declare const createOnDropHandler: <T>(onChangeChildren: (item: ItemInstance<T>, newChildren: string[]) => void) => (items: ItemInstance<T>[], target: DragTarget<T>) => Promise<void>;
@@ -1,7 +1,16 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
1
10
  import { removeItemsFromParents } from "./remove-items-from-parents";
2
11
  import { insertItemsAtTarget } from "./insert-items-at-target";
3
- export const createOnDropHandler = (onChangeChildren) => (items, target) => {
12
+ export const createOnDropHandler = (onChangeChildren) => (items, target) => __awaiter(void 0, void 0, void 0, function* () {
4
13
  const itemIds = items.map((item) => item.getId());
5
- removeItemsFromParents(items, onChangeChildren);
6
- insertItemsAtTarget(itemIds, target, onChangeChildren);
7
- };
14
+ yield removeItemsFromParents(items, onChangeChildren);
15
+ yield insertItemsAtTarget(itemIds, target, onChangeChildren);
16
+ });