@headless-tree/core 0.0.0-20230802230636

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 (149) hide show
  1. package/CHANGELOG.md +43 -0
  2. package/lib/cjs/core/create-tree.d.ts +2 -0
  3. package/lib/cjs/core/create-tree.js +138 -0
  4. package/lib/cjs/features/async-data-loader/feature.d.ts +5 -0
  5. package/lib/cjs/features/async-data-loader/feature.js +88 -0
  6. package/lib/cjs/features/async-data-loader/types.d.ts +41 -0
  7. package/lib/cjs/features/async-data-loader/types.js +2 -0
  8. package/lib/cjs/features/drag-and-drop/feature.d.ts +3 -0
  9. package/lib/cjs/features/drag-and-drop/feature.js +138 -0
  10. package/lib/cjs/features/drag-and-drop/types.d.ts +69 -0
  11. package/lib/cjs/features/drag-and-drop/types.js +9 -0
  12. package/lib/cjs/features/drag-and-drop/utils.d.ts +6 -0
  13. package/lib/cjs/features/drag-and-drop/utils.js +79 -0
  14. package/lib/cjs/features/expand-all/feature.d.ts +6 -0
  15. package/lib/cjs/features/expand-all/feature.js +41 -0
  16. package/lib/cjs/features/expand-all/types.d.ts +17 -0
  17. package/lib/cjs/features/expand-all/types.js +2 -0
  18. package/lib/cjs/features/hotkeys-core/feature.d.ts +4 -0
  19. package/lib/cjs/features/hotkeys-core/feature.js +71 -0
  20. package/lib/cjs/features/hotkeys-core/types.d.ts +25 -0
  21. package/lib/cjs/features/hotkeys-core/types.js +2 -0
  22. package/lib/cjs/features/main/types.d.ts +39 -0
  23. package/lib/cjs/features/main/types.js +2 -0
  24. package/lib/cjs/features/renaming/feature.d.ts +5 -0
  25. package/lib/cjs/features/renaming/feature.js +64 -0
  26. package/lib/cjs/features/renaming/types.d.ts +27 -0
  27. package/lib/cjs/features/renaming/types.js +2 -0
  28. package/lib/cjs/features/search/feature.d.ts +5 -0
  29. package/lib/cjs/features/search/feature.js +103 -0
  30. package/lib/cjs/features/search/types.d.ts +33 -0
  31. package/lib/cjs/features/search/types.js +2 -0
  32. package/lib/cjs/features/selection/feature.d.ts +5 -0
  33. package/lib/cjs/features/selection/feature.js +113 -0
  34. package/lib/cjs/features/selection/types.d.ts +21 -0
  35. package/lib/cjs/features/selection/types.js +2 -0
  36. package/lib/cjs/features/sync-data-loader/feature.d.ts +4 -0
  37. package/lib/cjs/features/sync-data-loader/feature.js +14 -0
  38. package/lib/cjs/features/sync-data-loader/types.d.ts +19 -0
  39. package/lib/cjs/features/sync-data-loader/types.js +2 -0
  40. package/lib/cjs/features/tree/feature.d.ts +6 -0
  41. package/lib/cjs/features/tree/feature.js +230 -0
  42. package/lib/cjs/features/tree/types.d.ts +62 -0
  43. package/lib/cjs/features/tree/types.js +2 -0
  44. package/lib/cjs/index.d.ts +23 -0
  45. package/lib/cjs/index.js +39 -0
  46. package/lib/cjs/mddocs-entry.d.ts +21 -0
  47. package/lib/cjs/mddocs-entry.js +17 -0
  48. package/lib/cjs/types/core.d.ts +67 -0
  49. package/lib/cjs/types/core.js +2 -0
  50. package/lib/cjs/types/deep-merge.d.ts +13 -0
  51. package/lib/cjs/types/deep-merge.js +2 -0
  52. package/lib/cjs/utilities/create-on-drop-handler.d.ts +3 -0
  53. package/lib/cjs/utilities/create-on-drop-handler.js +11 -0
  54. package/lib/cjs/utilities/insert-items-at-target.d.ts +3 -0
  55. package/lib/cjs/utilities/insert-items-at-target.js +24 -0
  56. package/lib/cjs/utilities/remove-items-from-parents.d.ts +2 -0
  57. package/lib/cjs/utilities/remove-items-from-parents.js +17 -0
  58. package/lib/cjs/utils.d.ts +6 -0
  59. package/lib/cjs/utils.js +53 -0
  60. package/lib/esm/core/create-tree.d.ts +2 -0
  61. package/lib/esm/core/create-tree.js +134 -0
  62. package/lib/esm/features/async-data-loader/feature.d.ts +5 -0
  63. package/lib/esm/features/async-data-loader/feature.js +85 -0
  64. package/lib/esm/features/async-data-loader/types.d.ts +41 -0
  65. package/lib/esm/features/async-data-loader/types.js +1 -0
  66. package/lib/esm/features/drag-and-drop/feature.d.ts +3 -0
  67. package/lib/esm/features/drag-and-drop/feature.js +135 -0
  68. package/lib/esm/features/drag-and-drop/types.d.ts +69 -0
  69. package/lib/esm/features/drag-and-drop/types.js +6 -0
  70. package/lib/esm/features/drag-and-drop/utils.d.ts +6 -0
  71. package/lib/esm/features/drag-and-drop/utils.js +72 -0
  72. package/lib/esm/features/expand-all/feature.d.ts +6 -0
  73. package/lib/esm/features/expand-all/feature.js +38 -0
  74. package/lib/esm/features/expand-all/types.d.ts +17 -0
  75. package/lib/esm/features/expand-all/types.js +1 -0
  76. package/lib/esm/features/hotkeys-core/feature.d.ts +4 -0
  77. package/lib/esm/features/hotkeys-core/feature.js +68 -0
  78. package/lib/esm/features/hotkeys-core/types.d.ts +25 -0
  79. package/lib/esm/features/hotkeys-core/types.js +1 -0
  80. package/lib/esm/features/main/types.d.ts +39 -0
  81. package/lib/esm/features/main/types.js +1 -0
  82. package/lib/esm/features/renaming/feature.d.ts +5 -0
  83. package/lib/esm/features/renaming/feature.js +61 -0
  84. package/lib/esm/features/renaming/types.d.ts +27 -0
  85. package/lib/esm/features/renaming/types.js +1 -0
  86. package/lib/esm/features/search/feature.d.ts +5 -0
  87. package/lib/esm/features/search/feature.js +100 -0
  88. package/lib/esm/features/search/types.d.ts +33 -0
  89. package/lib/esm/features/search/types.js +1 -0
  90. package/lib/esm/features/selection/feature.d.ts +5 -0
  91. package/lib/esm/features/selection/feature.js +110 -0
  92. package/lib/esm/features/selection/types.d.ts +21 -0
  93. package/lib/esm/features/selection/types.js +1 -0
  94. package/lib/esm/features/sync-data-loader/feature.d.ts +4 -0
  95. package/lib/esm/features/sync-data-loader/feature.js +11 -0
  96. package/lib/esm/features/sync-data-loader/types.d.ts +19 -0
  97. package/lib/esm/features/sync-data-loader/types.js +1 -0
  98. package/lib/esm/features/tree/feature.d.ts +6 -0
  99. package/lib/esm/features/tree/feature.js +227 -0
  100. package/lib/esm/features/tree/types.d.ts +62 -0
  101. package/lib/esm/features/tree/types.js +1 -0
  102. package/lib/esm/index.d.ts +23 -0
  103. package/lib/esm/index.js +23 -0
  104. package/lib/esm/mddocs-entry.d.ts +21 -0
  105. package/lib/esm/mddocs-entry.js +1 -0
  106. package/lib/esm/types/core.d.ts +67 -0
  107. package/lib/esm/types/core.js +1 -0
  108. package/lib/esm/types/deep-merge.d.ts +13 -0
  109. package/lib/esm/types/deep-merge.js +1 -0
  110. package/lib/esm/utilities/create-on-drop-handler.d.ts +3 -0
  111. package/lib/esm/utilities/create-on-drop-handler.js +7 -0
  112. package/lib/esm/utilities/insert-items-at-target.d.ts +3 -0
  113. package/lib/esm/utilities/insert-items-at-target.js +20 -0
  114. package/lib/esm/utilities/remove-items-from-parents.d.ts +2 -0
  115. package/lib/esm/utilities/remove-items-from-parents.js +13 -0
  116. package/lib/esm/utils.d.ts +6 -0
  117. package/lib/esm/utils.js +46 -0
  118. package/package.json +23 -0
  119. package/src/core/create-tree.ts +228 -0
  120. package/src/features/async-data-loader/feature.ts +126 -0
  121. package/src/features/async-data-loader/types.ts +41 -0
  122. package/src/features/drag-and-drop/feature.ts +214 -0
  123. package/src/features/drag-and-drop/types.ts +89 -0
  124. package/src/features/drag-and-drop/utils.ts +117 -0
  125. package/src/features/expand-all/feature.ts +63 -0
  126. package/src/features/expand-all/types.ts +13 -0
  127. package/src/features/hotkeys-core/feature.ts +110 -0
  128. package/src/features/hotkeys-core/types.ts +36 -0
  129. package/src/features/main/types.ts +48 -0
  130. package/src/features/renaming/feature.ts +105 -0
  131. package/src/features/renaming/types.ts +28 -0
  132. package/src/features/search/feature.ts +158 -0
  133. package/src/features/search/types.ts +40 -0
  134. package/src/features/selection/feature.ts +157 -0
  135. package/src/features/selection/types.ts +28 -0
  136. package/src/features/sync-data-loader/feature.ts +41 -0
  137. package/src/features/sync-data-loader/types.ts +20 -0
  138. package/src/features/tree/feature.ts +326 -0
  139. package/src/features/tree/types.ts +78 -0
  140. package/src/index.ts +26 -0
  141. package/src/mddocs-entry.ts +26 -0
  142. package/src/types/core.ts +183 -0
  143. package/src/types/deep-merge.ts +31 -0
  144. package/src/utilities/create-on-drop-handler.ts +14 -0
  145. package/src/utilities/insert-items-at-target.ts +30 -0
  146. package/src/utilities/remove-items-from-parents.ts +21 -0
  147. package/src/utils.ts +68 -0
  148. package/tsconfig.json +7 -0
  149. package/typedoc.json +4 -0
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.expandAllFeature = void 0;
13
+ const utils_1 = require("../../utils");
14
+ exports.expandAllFeature = {
15
+ key: "expand-all",
16
+ createTreeInstance: (prev, tree) => (Object.assign(Object.assign({}, prev), { expandAll: (cancelToken) => __awaiter(void 0, void 0, void 0, function* () {
17
+ yield Promise.all(tree.getItems().map((item) => item.expandAll(cancelToken)));
18
+ }), collapseAll: () => {
19
+ tree.applySubStateUpdate("expandedItems", []);
20
+ tree.rebuildTree();
21
+ } })),
22
+ createItemInstance: (prev, item, tree) => (Object.assign(Object.assign({}, prev), { expandAll: (cancelToken) => __awaiter(void 0, void 0, void 0, function* () {
23
+ if (cancelToken === null || cancelToken === void 0 ? void 0 : cancelToken.current) {
24
+ return;
25
+ }
26
+ if (!item.isFolder()) {
27
+ return;
28
+ }
29
+ item.expand();
30
+ yield (0, utils_1.poll)(() => !tree.getState().loadingItems.includes(item.getId()));
31
+ yield Promise.all(item.getChildren().map((child) => __awaiter(void 0, void 0, void 0, function* () {
32
+ yield (0, utils_1.poll)(() => !tree.getState().loadingItems.includes(child.getId()));
33
+ yield (child === null || child === void 0 ? void 0 : child.expandAll(cancelToken));
34
+ })));
35
+ }), collapseAll: () => {
36
+ for (const child of item.getChildren()) {
37
+ child === null || child === void 0 ? void 0 : child.collapseAll();
38
+ }
39
+ item.collapse();
40
+ } })),
41
+ };
@@ -0,0 +1,17 @@
1
+ export type ExpandAllFeatureDef = {
2
+ state: {};
3
+ config: {};
4
+ treeInstance: {
5
+ expandAll: (cancelToken?: {
6
+ current: boolean;
7
+ }) => Promise<void>;
8
+ collapseAll: () => void;
9
+ };
10
+ itemInstance: {
11
+ expandAll: (cancelToken?: {
12
+ current: boolean;
13
+ }) => Promise<void>;
14
+ collapseAll: () => void;
15
+ };
16
+ hotkeys: never;
17
+ };
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,4 @@
1
+ import { FeatureImplementation } from "../../types/core";
2
+ import { HotkeysCoreFeatureDef } from "./types";
3
+ import { MainFeatureDef } from "../main/types";
4
+ export declare const hotkeysCoreFeature: FeatureImplementation<any, HotkeysCoreFeatureDef<any>, MainFeatureDef | HotkeysCoreFeatureDef<any>>;
@@ -0,0 +1,71 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.hotkeysCoreFeature = void 0;
4
+ const specialKeys = {
5
+ Letter: /^[a-z]$/,
6
+ LetterOrNumber: /^[a-z0-9]$/,
7
+ };
8
+ const testHotkeyMatch = (pressedKeys, tree, hotkey) => {
9
+ const supposedKeys = hotkey.hotkey.split("+");
10
+ const doKeysMatch = supposedKeys.every((key) => key in specialKeys
11
+ ? [...pressedKeys].some((pressedKey) => specialKeys[key].test(pressedKey))
12
+ : pressedKeys.has(key));
13
+ const isEnabled = !hotkey.isEnabled || hotkey.isEnabled(tree);
14
+ const equalCounts = pressedKeys.size === supposedKeys.length;
15
+ return doKeysMatch && isEnabled && equalCounts;
16
+ };
17
+ const findHotkeyMatch = (pressedKeys, tree, config1, config2) => {
18
+ var _a;
19
+ return (_a = Object.entries(Object.assign(Object.assign({}, config1), config2)).find(([, hotkey]) => testHotkeyMatch(pressedKeys, tree, hotkey))) === null || _a === void 0 ? void 0 : _a[0];
20
+ };
21
+ exports.hotkeysCoreFeature = {
22
+ key: "hotkeys-core",
23
+ onTreeMount: (tree, element) => {
24
+ const data = tree.getDataRef();
25
+ const keydown = (e) => {
26
+ var _a, _b;
27
+ var _c;
28
+ (_a = (_c = data.current).pressedKeys) !== null && _a !== void 0 ? _a : (_c.pressedKeys = new Set());
29
+ const newMatch = !data.current.pressedKeys.has(e.key);
30
+ data.current.pressedKeys.add(e.key);
31
+ const hotkeyName = findHotkeyMatch(data.current.pressedKeys, tree, tree.getHotkeyPresets(), tree.getConfig().hotkeys);
32
+ if (!hotkeyName)
33
+ return;
34
+ const hotkeyConfig = Object.assign(Object.assign({}, tree.getHotkeyPresets()[hotkeyName]), (_b = tree.getConfig().hotkeys) === null || _b === void 0 ? void 0 : _b[hotkeyName]);
35
+ if (!hotkeyConfig)
36
+ return;
37
+ if (!hotkeyConfig.allowWhenInputFocused &&
38
+ e.target instanceof HTMLInputElement)
39
+ return;
40
+ if (!hotkeyConfig.canRepeat && !newMatch)
41
+ return;
42
+ if (hotkeyConfig.preventDefault)
43
+ e.preventDefault();
44
+ hotkeyConfig.handler(e, tree);
45
+ };
46
+ const keyup = (e) => {
47
+ var _a;
48
+ var _b;
49
+ (_a = (_b = data.current).pressedKeys) !== null && _a !== void 0 ? _a : (_b.pressedKeys = new Set());
50
+ data.current.pressedKeys.delete(e.key);
51
+ };
52
+ // keyup is registered on document, because some hotkeys shift
53
+ // the focus away from the tree (i.e. search)
54
+ // and then we wouldn't get the keyup event anymore
55
+ element.addEventListener("keydown", keydown);
56
+ document.addEventListener("keyup", keyup);
57
+ data.current.keydownHandler = keydown;
58
+ data.current.keyupHandler = keyup;
59
+ },
60
+ onTreeUnmount: (tree, element) => {
61
+ const data = tree.getDataRef();
62
+ if (data.current.keyupHandler) {
63
+ document.removeEventListener("keyup", data.current.keyupHandler);
64
+ delete data.current.keyupHandler;
65
+ }
66
+ if (data.current.keydownHandler) {
67
+ element.removeEventListener("keydown", data.current.keydownHandler);
68
+ delete data.current.keydownHandler;
69
+ }
70
+ },
71
+ };
@@ -0,0 +1,25 @@
1
+ import { CustomHotkeysConfig, ItemInstance, TreeInstance } from "../../types/core";
2
+ export interface HotkeyConfig<T> {
3
+ hotkey: string;
4
+ canRepeat?: boolean;
5
+ allowWhenInputFocused?: boolean;
6
+ isEnabled?: (tree: TreeInstance<T>) => boolean;
7
+ preventDefault?: boolean;
8
+ handler: (e: KeyboardEvent, tree: TreeInstance<T>) => void;
9
+ }
10
+ export type HotkeysCoreDataRef = {
11
+ keydownHandler?: (e: KeyboardEvent) => void;
12
+ keyupHandler?: (e: KeyboardEvent) => void;
13
+ pressedKeys: Set<string>;
14
+ };
15
+ export type HotkeysCoreFeatureDef<T> = {
16
+ state: {};
17
+ config: {
18
+ hotkeys?: CustomHotkeysConfig<T>;
19
+ onTreeHotkey?: (name: string, element: HTMLElement) => void;
20
+ onItemHotkey?: (name: string, item: ItemInstance<T>, element: HTMLElement) => void;
21
+ };
22
+ treeInstance: {};
23
+ itemInstance: {};
24
+ hotkeys: never;
25
+ };
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,39 @@
1
+ import { FeatureImplementation, HotkeysConfig, ItemInstance, SetStateFn, TreeConfig, TreeState, Updater } from "../../types/core";
2
+ import { ItemMeta } from "../tree/types";
3
+ export type MainFeatureDef<T = any> = {
4
+ state: {};
5
+ config: {
6
+ features?: FeatureImplementation<any>[];
7
+ initialState?: Partial<TreeState<T>>;
8
+ state?: Partial<TreeState<T>>;
9
+ setState?: SetStateFn<TreeState<T>>;
10
+ };
11
+ treeInstance: {
12
+ /** @internal */
13
+ applySubStateUpdate: <K extends keyof TreeState<any>>(stateName: K, updater: Updater<TreeState<T>[K]>) => void;
14
+ setState: SetStateFn<TreeState<T>>;
15
+ getState: () => TreeState<T>;
16
+ setConfig: SetStateFn<TreeConfig<T>>;
17
+ getConfig: () => TreeConfig<T>;
18
+ getItemInstance: (itemId: string) => ItemInstance<T>;
19
+ getItems: () => ItemInstance<T>[];
20
+ registerElement: (element: HTMLElement | null) => void;
21
+ getElement: () => HTMLElement | undefined | null;
22
+ /** @internal */
23
+ getDataRef: <D>() => {
24
+ current: D;
25
+ };
26
+ getHotkeyPresets: () => HotkeysConfig<T>;
27
+ rebuildTree: () => void;
28
+ };
29
+ itemInstance: {
30
+ registerElement: (element: HTMLElement | null) => void;
31
+ getItemMeta: () => ItemMeta;
32
+ getElement: () => HTMLElement | undefined | null;
33
+ /** @internal */
34
+ getDataRef: <D>() => {
35
+ current: D;
36
+ };
37
+ };
38
+ hotkeys: never;
39
+ };
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,5 @@
1
+ import { FeatureImplementation } from "../../types/core";
2
+ import { RenamingFeatureDef } from "./types";
3
+ import { MainFeatureDef } from "../main/types";
4
+ import { TreeFeatureDef } from "../tree/types";
5
+ export declare const renamingFeature: FeatureImplementation<any, RenamingFeatureDef<any>, MainFeatureDef | TreeFeatureDef<any> | RenamingFeatureDef<any>>;
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.renamingFeature = void 0;
4
+ const utils_1 = require("../../utils");
5
+ exports.renamingFeature = {
6
+ key: "renaming",
7
+ getDefaultConfig: (defaultConfig, tree) => (Object.assign({ setRenamingItem: (0, utils_1.makeStateUpdater)("renamingItem", tree), setRenamingValue: (0, utils_1.makeStateUpdater)("renamingValue", tree), canRename: () => true }, defaultConfig)),
8
+ stateHandlerNames: {
9
+ renamingItem: "setRenamingItem",
10
+ renamingValue: "setRenamingValue",
11
+ },
12
+ createTreeInstance: (prev, instance) => (Object.assign(Object.assign({}, prev), { startRenamingItem: (itemId) => {
13
+ const item = instance.getItemInstance(itemId);
14
+ if (!item.canRename()) {
15
+ return;
16
+ }
17
+ instance.applySubStateUpdate("renamingItem", itemId);
18
+ instance.applySubStateUpdate("renamingValue", item.getItemName());
19
+ }, getRenamingItem: () => {
20
+ const itemId = instance.getState().renamingItem;
21
+ return itemId ? instance.getItemInstance(itemId) : null;
22
+ }, getRenamingValue: () => instance.getState().renamingValue || "", abortRenaming: () => {
23
+ instance.applySubStateUpdate("renamingItem", null);
24
+ }, completeRenaming: () => {
25
+ var _a;
26
+ const config = instance.getConfig();
27
+ const item = instance.getRenamingItem();
28
+ if (item) {
29
+ (_a = config.onRename) === null || _a === void 0 ? void 0 : _a.call(config, item, instance.getState().renamingValue || "");
30
+ }
31
+ instance.applySubStateUpdate("renamingItem", null);
32
+ }, isRenamingItem: () => !!instance.getState().renamingItem })),
33
+ createItemInstance: (prev, instance, tree) => (Object.assign(Object.assign({}, prev), { getRenameInputProps: () => ({
34
+ onBlur: () => tree.abortRenaming(),
35
+ value: tree.getRenamingValue(),
36
+ onChange: (e) => {
37
+ tree.applySubStateUpdate("renamingValue", e.target.value);
38
+ },
39
+ }), canRename: () => { var _a, _b, _c; return (_c = (_b = (_a = tree.getConfig()).canRename) === null || _b === void 0 ? void 0 : _b.call(_a, instance)) !== null && _c !== void 0 ? _c : true; }, isRenaming: () => instance.getId() === tree.getState().renamingItem })),
40
+ hotkeys: {
41
+ renameItem: {
42
+ hotkey: "F2",
43
+ handler: (e, tree) => {
44
+ tree.startRenamingItem(tree.getFocusedItem().getId());
45
+ },
46
+ },
47
+ abortRenaming: {
48
+ hotkey: "Escape",
49
+ allowWhenInputFocused: true,
50
+ isEnabled: (tree) => tree.isRenamingItem(),
51
+ handler: (e, tree) => {
52
+ tree.abortRenaming();
53
+ },
54
+ },
55
+ completeRenaming: {
56
+ hotkey: "Enter",
57
+ allowWhenInputFocused: true,
58
+ isEnabled: (tree) => tree.isRenamingItem(),
59
+ handler: (e, tree) => {
60
+ tree.completeRenaming();
61
+ },
62
+ },
63
+ },
64
+ };
@@ -0,0 +1,27 @@
1
+ import { ItemInstance, SetStateFn } from "../../types/core";
2
+ export type RenamingFeatureDef<T> = {
3
+ state: {
4
+ renamingItem?: string | null;
5
+ renamingValue?: string;
6
+ };
7
+ config: {
8
+ setRenamingItem?: SetStateFn<string | null>;
9
+ setRenamingValue?: SetStateFn<string | undefined>;
10
+ canRename?: (item: ItemInstance<T>) => boolean;
11
+ onRename?: (item: ItemInstance<T>, value: string) => void;
12
+ };
13
+ treeInstance: {
14
+ startRenamingItem: (itemId: string) => void;
15
+ getRenamingItem: () => ItemInstance<T> | null;
16
+ getRenamingValue: () => string;
17
+ abortRenaming: () => void;
18
+ completeRenaming: () => void;
19
+ isRenamingItem: () => boolean;
20
+ };
21
+ itemInstance: {
22
+ getRenameInputProps: () => any;
23
+ canRename: () => boolean;
24
+ isRenaming: () => boolean;
25
+ };
26
+ hotkeys: "renameItem" | "abortRenaming" | "completeRenaming";
27
+ };
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,5 @@
1
+ import { FeatureImplementation } from "../../types/core";
2
+ import { SearchFeatureDef } from "./types";
3
+ import { MainFeatureDef } from "../main/types";
4
+ import { TreeFeatureDef } from "../tree/types";
5
+ export declare const searchFeature: FeatureImplementation<any, SearchFeatureDef<any>, MainFeatureDef | TreeFeatureDef<any> | SearchFeatureDef<any>>;
@@ -0,0 +1,103 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.searchFeature = void 0;
4
+ const utils_1 = require("../../utils");
5
+ exports.searchFeature = {
6
+ key: "search",
7
+ getInitialState: (initialState) => (Object.assign({ search: null }, initialState)),
8
+ getDefaultConfig: (defaultConfig, tree) => (Object.assign({ setSearch: (0, utils_1.makeStateUpdater)("search", tree), isSearchMatchingItem: (search, item) => search.length > 0 &&
9
+ item.getItemName().toLowerCase().includes(search.toLowerCase()) }, defaultConfig)),
10
+ stateHandlerNames: {
11
+ search: "setSearch",
12
+ },
13
+ createTreeInstance: (prev, instance) => (Object.assign(Object.assign({}, prev), { setSearch: (search) => {
14
+ var _a;
15
+ instance.applySubStateUpdate("search", search);
16
+ (_a = instance
17
+ .getItems()
18
+ .find((item) => {
19
+ var _a, _b;
20
+ return (_b = (_a = instance
21
+ .getConfig()).isSearchMatchingItem) === null || _b === void 0 ? void 0 : _b.call(_a, instance.getSearchValue(), item);
22
+ })) === null || _a === void 0 ? void 0 : _a.setFocused();
23
+ }, openSearch: (initialValue = "") => {
24
+ instance.setSearch(initialValue);
25
+ setTimeout(() => {
26
+ var _a;
27
+ (_a = instance
28
+ .getDataRef()
29
+ .current.searchInput) === null || _a === void 0 ? void 0 : _a.focus();
30
+ });
31
+ }, closeSearch: () => {
32
+ instance.setSearch(null);
33
+ instance.updateDomFocus();
34
+ }, isSearchOpen: () => instance.getState().search !== null, getSearchValue: () => instance.getState().search || "", registerSearchInputElement: (element) => {
35
+ const dataRef = instance.getDataRef();
36
+ dataRef.current.searchInput = element;
37
+ if (element && dataRef.current.keydownHandler) {
38
+ element.addEventListener("keydown", dataRef.current.keydownHandler);
39
+ }
40
+ }, getSearchInputElement: () => { var _a; return (_a = instance.getDataRef().current.searchInput) !== null && _a !== void 0 ? _a : null; }, getSearchInputElementProps: () => ({
41
+ value: instance.getSearchValue(),
42
+ onChange: (e) => instance.setSearch(e.target.value),
43
+ onBlur: () => instance.closeSearch(),
44
+ }), getSearchMatchingItems: (0, utils_1.memo)((search, items) => items.filter((item) => { var _a, _b; return search && ((_b = (_a = instance.getConfig()).isSearchMatchingItem) === null || _b === void 0 ? void 0 : _b.call(_a, search, item)); }), () => [instance.getSearchValue(), instance.getItems()]) })),
45
+ createItemInstance: (prev, item, tree) => (Object.assign(Object.assign({}, prev), { isMatchingSearch: () => tree.getSearchMatchingItems().some((i) => i.getId() === item.getId()) })),
46
+ hotkeys: {
47
+ openSearch: {
48
+ hotkey: "LetterOrNumber",
49
+ preventDefault: true,
50
+ isEnabled: (tree) => !tree.isSearchOpen(),
51
+ handler: (e, tree) => {
52
+ e.stopPropagation();
53
+ tree.openSearch(e.key);
54
+ },
55
+ },
56
+ closeSearch: {
57
+ // TODO allow multiple, i.e. Enter
58
+ hotkey: "Escape",
59
+ allowWhenInputFocused: true,
60
+ isEnabled: (tree) => tree.isSearchOpen(),
61
+ handler: (e, tree) => {
62
+ tree.closeSearch();
63
+ },
64
+ },
65
+ submitSearch: {
66
+ hotkey: "Enter",
67
+ allowWhenInputFocused: true,
68
+ isEnabled: (tree) => tree.isSearchOpen(),
69
+ handler: (e, tree) => {
70
+ tree.closeSearch();
71
+ tree.setSelectedItems([tree.getFocusedItem().getId()]);
72
+ },
73
+ },
74
+ nextSearchItem: {
75
+ hotkey: "ArrowDown",
76
+ allowWhenInputFocused: true,
77
+ canRepeat: true,
78
+ isEnabled: (tree) => tree.isSearchOpen(),
79
+ handler: (e, tree) => {
80
+ const focusItem = tree
81
+ .getSearchMatchingItems()
82
+ .find((item) => item.getItemMeta().index >
83
+ tree.getFocusedItem().getItemMeta().index);
84
+ focusItem === null || focusItem === void 0 ? void 0 : focusItem.setFocused();
85
+ focusItem === null || focusItem === void 0 ? void 0 : focusItem.scrollTo({ block: "nearest", inline: "nearest" });
86
+ },
87
+ },
88
+ previousSearchItem: {
89
+ hotkey: "ArrowUp",
90
+ allowWhenInputFocused: true,
91
+ canRepeat: true,
92
+ isEnabled: (tree) => tree.isSearchOpen(),
93
+ handler: (e, tree) => {
94
+ const focusItem = [...tree.getSearchMatchingItems()]
95
+ .reverse()
96
+ .find((item) => item.getItemMeta().index <
97
+ tree.getFocusedItem().getItemMeta().index);
98
+ focusItem === null || focusItem === void 0 ? void 0 : focusItem.setFocused();
99
+ focusItem === null || focusItem === void 0 ? void 0 : focusItem.scrollTo({ block: "nearest", inline: "nearest" });
100
+ },
101
+ },
102
+ },
103
+ };
@@ -0,0 +1,33 @@
1
+ import { ItemInstance, SetStateFn } from "../../types/core";
2
+ import { HotkeysCoreDataRef } from "../hotkeys-core/types";
3
+ export type SearchFeatureDataRef<T = any> = HotkeysCoreDataRef & {
4
+ matchingItems: ItemInstance<T>[];
5
+ searchInput: HTMLInputElement | null;
6
+ };
7
+ export type SearchFeatureDef<T> = {
8
+ state: {
9
+ search: string | null;
10
+ };
11
+ config: {
12
+ setSearch?: SetStateFn<string | null>;
13
+ onOpenSearch?: () => void;
14
+ onCloseSearch?: () => void;
15
+ onSearchMatchesItems?: (search: string, items: ItemInstance<T>[]) => void;
16
+ isSearchMatchingItem?: (search: string, item: ItemInstance<T>) => boolean;
17
+ };
18
+ treeInstance: {
19
+ setSearch: (search: string | null) => void;
20
+ openSearch: (initialValue?: string) => void;
21
+ closeSearch: () => void;
22
+ isSearchOpen: () => boolean;
23
+ getSearchValue: () => string;
24
+ registerSearchInputElement: (element: HTMLInputElement | null) => void;
25
+ getSearchInputElement: () => HTMLInputElement | null;
26
+ getSearchInputElementProps: () => any;
27
+ getSearchMatchingItems: () => ItemInstance<T>[];
28
+ };
29
+ itemInstance: {
30
+ isMatchingSearch: () => boolean;
31
+ };
32
+ hotkeys: "openSearch" | "closeSearch" | "submitSearch" | "nextSearchItem" | "previousSearchItem";
33
+ };
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,5 @@
1
+ import { FeatureImplementation } from "../../types/core";
2
+ import { SelectionFeatureDef } from "./types";
3
+ import { MainFeatureDef } from "../main/types";
4
+ import { TreeFeatureDef } from "../tree/types";
5
+ export declare const selectionFeature: FeatureImplementation<any, SelectionFeatureDef<any>, MainFeatureDef | TreeFeatureDef<any> | SelectionFeatureDef<any>>;
@@ -0,0 +1,113 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.selectionFeature = void 0;
4
+ const utils_1 = require("../../utils");
5
+ exports.selectionFeature = {
6
+ key: "selection",
7
+ getInitialState: (initialState) => (Object.assign({ selectedItems: [] }, initialState)),
8
+ getDefaultConfig: (defaultConfig, tree) => (Object.assign({ setSelectedItems: (0, utils_1.makeStateUpdater)("selectedItems", tree) }, defaultConfig)),
9
+ stateHandlerNames: {
10
+ selectedItems: "setSelectedItems",
11
+ },
12
+ createTreeInstance: (prev, instance) => (Object.assign(Object.assign({}, prev), { setSelectedItems: (selectedItems) => {
13
+ instance.applySubStateUpdate("selectedItems", selectedItems);
14
+ },
15
+ // TODO memo
16
+ getSelectedItems: () => {
17
+ return instance.getState().selectedItems.map(instance.getItemInstance);
18
+ } })),
19
+ createItemInstance: (prev, item, tree) => (Object.assign(Object.assign({}, prev), { select: () => {
20
+ const { selectedItems } = tree.getState();
21
+ tree.setSelectedItems(selectedItems.includes(item.getItemMeta().itemId)
22
+ ? selectedItems
23
+ : [...selectedItems, item.getItemMeta().itemId]);
24
+ }, deselect: () => {
25
+ const { selectedItems } = tree.getState();
26
+ tree.setSelectedItems(selectedItems.filter((id) => id !== item.getItemMeta().itemId));
27
+ }, isSelected: () => {
28
+ const { selectedItems } = tree.getState();
29
+ return selectedItems.includes(item.getItemMeta().itemId);
30
+ }, selectUpTo: (ctrl) => {
31
+ const indexA = item.getItemMeta().index;
32
+ // TODO dont use focused item as anchor, but last primary-clicked item
33
+ const indexB = tree.getFocusedItem().getItemMeta().index;
34
+ const [a, b] = indexA < indexB ? [indexA, indexB] : [indexB, indexA];
35
+ const newSelectedItems = tree
36
+ .getItems()
37
+ .slice(a, b + 1)
38
+ .map((treeItem) => treeItem.getItemMeta().itemId);
39
+ if (!ctrl) {
40
+ tree.setSelectedItems(newSelectedItems);
41
+ return;
42
+ }
43
+ const { selectedItems } = tree.getState();
44
+ const uniqueSelectedItems = [
45
+ ...new Set([...selectedItems, ...newSelectedItems]),
46
+ ];
47
+ tree.setSelectedItems(uniqueSelectedItems);
48
+ }, toggleSelect: () => {
49
+ if (item.isSelected()) {
50
+ item.deselect();
51
+ }
52
+ else {
53
+ item.select();
54
+ }
55
+ }, getProps: () => (Object.assign(Object.assign({}, prev.getProps()), { "aria-selected": item.isSelected() ? "true" : "false", onClick: item.getMemoizedProp("selection/onClick", () => (e) => {
56
+ var _a, _b;
57
+ if (e.shiftKey) {
58
+ item.selectUpTo(e.ctrlKey || e.metaKey);
59
+ }
60
+ else if (e.ctrlKey || e.metaKey) {
61
+ item.toggleSelect();
62
+ }
63
+ else {
64
+ tree.setSelectedItems([item.getItemMeta().itemId]);
65
+ }
66
+ (_b = (_a = prev.getProps()).onClick) === null || _b === void 0 ? void 0 : _b.call(_a, e);
67
+ }) })) })),
68
+ hotkeys: {
69
+ // setSelectedItem: {
70
+ // hotkey: "space",
71
+ // handler: (e, tree) => {
72
+ // tree.setSelectedItems([tree.getFocusedItem().getId()]);
73
+ // },
74
+ // },
75
+ toggleSelectItem: {
76
+ hotkey: "ctrl+space",
77
+ handler: (e, tree) => {
78
+ tree.getFocusedItem().toggleSelect();
79
+ },
80
+ },
81
+ selectUpwards: {
82
+ hotkey: "shift+ArrowUp",
83
+ handler: () => {
84
+ // TODO
85
+ },
86
+ },
87
+ selectDownwards: {
88
+ hotkey: "shift+ArrowDown",
89
+ handler: () => {
90
+ // TODO
91
+ },
92
+ },
93
+ selectUpwardsCtrl: {
94
+ hotkey: "shift+ctrl+ArrowUp",
95
+ handler: () => {
96
+ // TODO
97
+ },
98
+ },
99
+ selectDownwardsCtrl: {
100
+ hotkey: "shift+ctrl+ArrowUp",
101
+ handler: () => {
102
+ // TODO
103
+ },
104
+ },
105
+ selectAll: {
106
+ hotkey: "Control+a",
107
+ preventDefault: true,
108
+ handler: (e, tree) => {
109
+ tree.setSelectedItems(tree.getItems().map((item) => item.getId()));
110
+ },
111
+ },
112
+ },
113
+ };
@@ -0,0 +1,21 @@
1
+ import { ItemInstance, SetStateFn } from "../../types/core";
2
+ export type SelectionFeatureDef<T> = {
3
+ state: {
4
+ selectedItems: string[];
5
+ };
6
+ config: {
7
+ setSelectedItems?: SetStateFn<string[]>;
8
+ };
9
+ treeInstance: {
10
+ setSelectedItems: (selectedItems: string[]) => void;
11
+ getSelectedItems: () => ItemInstance<T>[];
12
+ };
13
+ itemInstance: {
14
+ select: () => void;
15
+ deselect: () => void;
16
+ toggleSelect: () => void;
17
+ isSelected: () => boolean;
18
+ selectUpTo: (ctrl: boolean) => void;
19
+ };
20
+ hotkeys: "toggleSelectItem" | "selectUpwards" | "selectDownwards" | "selectUpwardsCtrl" | "selectDownwardsCtrl" | "selectAll";
21
+ };
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,4 @@
1
+ import { FeatureImplementation } from "../../types/core";
2
+ import { SyncDataLoaderFeatureDef } from "./types";
3
+ import { MainFeatureDef } from "../main/types";
4
+ export declare const syncDataLoaderFeature: FeatureImplementation<any, SyncDataLoaderFeatureDef<any>, MainFeatureDef | SyncDataLoaderFeatureDef<any>>;
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.syncDataLoaderFeature = void 0;
4
+ const utils_1 = require("../../utils");
5
+ exports.syncDataLoaderFeature = {
6
+ key: "sync-data-loader",
7
+ getInitialState: (initialState) => (Object.assign({ loadingItems: [] }, initialState)),
8
+ getDefaultConfig: (defaultConfig, tree) => (Object.assign({ setLoadingItems: (0, utils_1.makeStateUpdater)("loadingItems", tree) }, defaultConfig)),
9
+ stateHandlerNames: {
10
+ loadingItems: "setLoadingItems",
11
+ },
12
+ createTreeInstance: (prev, instance) => (Object.assign(Object.assign({}, prev), { retrieveItemData: (itemId) => instance.getConfig().dataLoader.getItem(itemId), retrieveChildrenIds: (itemId) => instance.getConfig().dataLoader.getChildren(itemId) })),
13
+ createItemInstance: (prev) => (Object.assign(Object.assign({}, prev), { isLoading: () => false })),
14
+ };
@@ -0,0 +1,19 @@
1
+ export type SyncTreeDataLoader<T> = {
2
+ getItem: (itemId: string) => T;
3
+ getChildren: (itemId: string) => string[];
4
+ };
5
+ export type SyncDataLoaderFeatureDef<T> = {
6
+ state: {};
7
+ config: {
8
+ rootItemId: string;
9
+ dataLoader?: SyncTreeDataLoader<T>;
10
+ };
11
+ treeInstance: {
12
+ retrieveItemData: (itemId: string) => T;
13
+ retrieveChildrenIds: (itemId: string) => string[];
14
+ };
15
+ itemInstance: {
16
+ isLoading: () => boolean;
17
+ };
18
+ hotkeys: never;
19
+ };