@snack-uikit/tree 0.11.1-preview-c3fee040.0 → 0.11.1-preview-02fd9f01.0

package/README.md

@@ -90,18 +90,6 @@ function TreeAsyncLoadExample() {
 
 [//]: DOCUMENTATION_SECTION_START
 [//]: THIS_SECTION_IS_AUTOGENERATED_PLEASE_DONT_EDIT_IT
-## getSearchedTreeItems
-### Props
-| name | type | default value | description |
-|------|------|---------------|-------------|
-| tree* | `ExtendedTreeNodeProps[]` | - |  |
-| searchOptions | `Partial<{ query: string; includeChildrenMatchedParent: boolean; }>` | - |  |
-## getSearchedTreeNodeById
-### Props
-| name | type | default value | description |
-|------|------|---------------|-------------|
-| searchOptions* | `{ id: I; includeNested?: boolean; }` | - |  |
-| tree* | `T[]` | - |  |
 ## Tree
 ### Props
 | name | type | default value | description |
@@ -124,8 +112,8 @@ function TreeAsyncLoadExample() {
 ### Props
 | name | type | default value | description |
 |------|------|---------------|-------------|
-| __@unscopables@986* | `{ [x: number]: boolean; length?: boolean; toString?: boolean; toLocaleString?: boolean; pop?: boolean; push?: boolean; concat?: boolean; join?: boolean; reverse?: boolean; shift?: boolean; slice?: boolean; sort?: boolean; ... 29 more ...; readonly [Symbol.unscopables]?: boolean; }` | - | Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. |
-| __@iterator@984* | `() => ArrayIterator<TreeNodeProps>` | - | Iterator |
+| __@unscopables@987* | `{ [x: number]: boolean; length?: boolean; toString?: boolean; toLocaleString?: boolean; pop?: boolean; push?: boolean; concat?: boolean; join?: boolean; reverse?: boolean; shift?: boolean; slice?: boolean; sort?: boolean; ... 29 more ...; readonly [Symbol.unscopables]?: boolean; }` | - | Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. |
+| __@iterator@985* | `() => ArrayIterator<TreeNodeProps>` | - | Iterator |
 | with* | `(index: number, value: TreeNodeProps) => TreeNodeProps[]` | - | Copies an array, then overwrites the value at the provided index with the given value. If the index is negative, then it replaces from the end of the array. @param index The index of the value to overwrite. If the index is negative, then it replaces from the end of the array. @param value The value to write into the copied array. @returns The copied array with the updated value. |
 | toSpliced* | `{ (start: number, deleteCount: number, ...items: TreeNodeProps[]): TreeNodeProps[]; (start: number, deleteCount?: number): TreeNodeProps[]; }` | - | Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array. Copies an array and removes elements while returning the remaining elements. @param start The zero-based location in the array from which to start removing elements. @param deleteCount The number of elements to remove. @param items Elements to insert into the copied array in place of the deleted elements. @returns The copied array. @param start The zero-based location in the array from which to start removing elements. @param deleteCount The number of elements to remove. @returns A copy of the original array with the remaining elements. |
 | toSorted* | `(compareFn?: (a: TreeNodeProps, b: TreeNodeProps) => number) => TreeNodeProps[]` | - | Returns a copy of an array with its elements sorted. @param compareFn Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order. ```ts [11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22] ``` |
@@ -188,8 +176,8 @@ function TreeAsyncLoadExample() {
 ### Props
 | name | type | default value | description |
 |------|------|---------------|-------------|
-| __@unscopables@986* | `{ [x: number]: boolean; length?: boolean; toString?: boolean; toLocaleString?: boolean; pop?: boolean; push?: boolean; concat?: boolean; join?: boolean; reverse?: boolean; shift?: boolean; slice?: boolean; sort?: boolean; ... 29 more ...; readonly [Symbol.unscopables]?: boolean; }` | - | Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. |
-| __@iterator@984* | `() => ArrayIterator<ExtendedTreeNodeProps>` | - | Iterator |
+| __@unscopables@987* | `{ [x: number]: boolean; length?: boolean; toString?: boolean; toLocaleString?: boolean; pop?: boolean; push?: boolean; concat?: boolean; join?: boolean; reverse?: boolean; shift?: boolean; slice?: boolean; sort?: boolean; ... 29 more ...; readonly [Symbol.unscopables]?: boolean; }` | - | Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. |
+| __@iterator@985* | `() => ArrayIterator<ExtendedTreeNodeProps>` | - | Iterator |
 | with* | `(index: number, value: ExtendedTreeNodeProps) => ExtendedTreeNodeProps[]` | - | Copies an array, then overwrites the value at the provided index with the given value. If the index is negative, then it replaces from the end of the array. @param index The index of the value to overwrite. If the index is negative, then it replaces from the end of the array. @param value The value to write into the copied array. @returns The copied array with the updated value. |
 | toSpliced* | `{ (start: number, deleteCount: number, ...items: ExtendedTreeNodeProps[]): ExtendedTreeNodeProps[]; (start: number, deleteCount?: number): ExtendedTreeNodeProps[]; }` | - | Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array. Copies an array and removes elements while returning the remaining elements. @param start The zero-based location in the array from which to start removing elements. @param deleteCount The number of elements to remove. @param items Elements to insert into the copied array in place of the deleted elements. @returns The copied array. @param start The zero-based location in the array from which to start removing elements. @param deleteCount The number of elements to remove. @returns A copy of the original array with the remaining elements. |
 | toSorted* | `(compareFn?: (a: ExtendedTreeNodeProps, b: ExtendedTreeNodeProps) => number) => ExtendedTreeNodeProps[]` | - | Returns a copy of an array with its elements sorted. @param compareFn Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order. ```ts [11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22] ``` |
@@ -229,6 +217,13 @@ function TreeAsyncLoadExample() {
 | length* | `number` | - | Gets or sets the length of the array. This is a number one higher than the highest index in the array. |
 | toString | `() => string` | function toString() { [native code] } | Returns a string representation of an array. |
 | toLocaleString | `{ (): string; (locales: string \| string[], options?: NumberFormatOptions & DateTimeFormatOptions): string; }` | function toLocaleString() { [native code] } | Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. |
+## traverseWithTarget
+BFS с указанием целевого списка для каждого узла.
+Очередь хранит (node, depth, targetList). Callback добавляет узел в targetList
+и возвращает массив для детей (или undefined, чтобы не обходить детей).
+### Props
+| name | type | default value | description |
+|------|------|---------------|-------------|
 
 
 [//]: DOCUMENTATION_SECTION_END

package/dist/cjs/hooks/__tests__/useSearchableTree.spec.js

@@ -175,7 +175,8 @@ const mapNodeToRecordItem = node => ({
     });
     yield (0, react_1.waitFor)(() => {
       (0, vitest_1.expect)(onSearch).toHaveBeenCalledWith({
-        search: 'query'
+        search: 'query',
+        expandedNodes: ['expandable-root']
       }, vitest_1.expect.any(AbortSignal));
       (0, vitest_1.expect)(onPreloadNodes).toHaveBeenCalledWith(['expandable-root', 'external-root'], vitest_1.expect.any(AbortSignal));
     });
@@ -213,7 +214,8 @@ const mapNodeToRecordItem = node => ({
     });
     yield (0, react_1.waitFor)(() => {
       (0, vitest_1.expect)(onSearch).toHaveBeenCalledWith({
-        search: 'query'
+        search: 'query',
+        expandedNodes: []
       }, vitest_1.expect.any(AbortSignal));
       (0, vitest_1.expect)(result.current.tree.current).toEqual([createParent('root-node', [createLeaf('child-node')])]);
     });

package/dist/cjs/hooks/useSearchableTree.d.ts

@@ -5,6 +5,7 @@ export type SearchResult<TTreeNode extends TreeNodeProps> = {
 };
 export type SearchParams = {
     search: string;
+    expandedNodes: string[];
 };
 type UseSearchableTreeParams<TRecordValue, TTreeNode extends TreeNodeProps> = {
     initTree: TTreeNode[];

package/dist/cjs/hooks/useSearchableTree.js

@@ -84,7 +84,8 @@ function useSearchableTree(_ref) {
     const abortController = new AbortController();
     searchAbortControllerRef.current = abortController;
     const searchPromise = (0, cancelable_promise_1.cancelable)(onSearch({
-      search: searchQuery
+      search: searchQuery,
+      expandedNodes: expandedNodes.current
     }, abortController.signal));
     searchPromiseRef.current = searchPromise;
     try {

package/dist/esm/hooks/__tests__/useSearchableTree.spec.js

@@ -122,7 +122,7 @@ describe('useSearchableTree', () => {
             result.current.search.onChange('query');
         });
         yield waitFor(() => {
-            expect(onSearch).toHaveBeenCalledWith({ search: 'query' }, expect.any(AbortSignal));
+            expect(onSearch).toHaveBeenCalledWith({ search: 'query', expandedNodes: ['expandable-root'] }, expect.any(AbortSignal));
             expect(onPreloadNodes).toHaveBeenCalledWith(['expandable-root', 'external-root'], expect.any(AbortSignal));
         });
         expect(result.current.tree.current).toEqual([
@@ -153,7 +153,7 @@ describe('useSearchableTree', () => {
             result.current.search.onChange('query');
         });
         yield waitFor(() => {
-            expect(onSearch).toHaveBeenCalledWith({ search: 'query' }, expect.any(AbortSignal));
+            expect(onSearch).toHaveBeenCalledWith({ search: 'query', expandedNodes: [] }, expect.any(AbortSignal));
             expect(result.current.tree.current).toEqual([createParent('root-node', [createLeaf('child-node')])]);
         });
         expect(result.current.expandedNodes.current).toEqual([]);

package/dist/esm/hooks/useSearchableTree.d.ts

@@ -5,6 +5,7 @@ export type SearchResult<TTreeNode extends TreeNodeProps> = {
 };
 export type SearchParams = {
     search: string;
+    expandedNodes: string[];
 };
 type UseSearchableTreeParams<TRecordValue, TTreeNode extends TreeNodeProps> = {
     initTree: TTreeNode[];

package/dist/esm/hooks/useSearchableTree.js

@@ -48,7 +48,7 @@ export function useSearchableTree({ initTree, onPreloadNode, onPreloadNodes, onS
         setLoading(true);
         const abortController = new AbortController();
         searchAbortControllerRef.current = abortController;
-        const searchPromise = cancelable(onSearch({ search: searchQuery }, abortController.signal));
+        const searchPromise = cancelable(onSearch({ search: searchQuery, expandedNodes: expandedNodes.current }, abortController.signal));
         searchPromiseRef.current = searchPromise;
         try {
             const { tree: searchedTree, needPreloadNodes } = yield searchPromise;

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "title": "Tree",
-  "version": "0.11.1-preview-c3fee040.0",
+  "version": "0.11.1-preview-02fd9f01.0",
   "sideEffects": [
     "*.css",
     "*.woff",
@@ -66,5 +66,5 @@
     "react-transition-state": "2.1.1",
     "uncontrollable": "8.0.4"
   },
-  "gitHead": "4aa46f03f56e45a92f8d7cbf49d91bcc7ae130cb"
+  "gitHead": "21fc47703dee986985b9c28cc94b94983ebfd4ef"
 }

package/src/hooks/__tests__/useSearchableTree.spec.ts

@@ -152,7 +152,10 @@ describe('useSearchableTree', () => {
     });
 
     await waitFor(() => {
-      expect(onSearch).toHaveBeenCalledWith({ search: 'query' }, expect.any(AbortSignal));
+      expect(onSearch).toHaveBeenCalledWith(
+        { search: 'query', expandedNodes: ['expandable-root'] },
+        expect.any(AbortSignal),
+      );
       expect(onPreloadNodes).toHaveBeenCalledWith(['expandable-root', 'external-root'], expect.any(AbortSignal));
     });
     expect(result.current.tree.current).toEqual([
@@ -187,7 +190,7 @@ describe('useSearchableTree', () => {
     });
 
     await waitFor(() => {
-      expect(onSearch).toHaveBeenCalledWith({ search: 'query' }, expect.any(AbortSignal));
+      expect(onSearch).toHaveBeenCalledWith({ search: 'query', expandedNodes: [] }, expect.any(AbortSignal));
       expect(result.current.tree.current).toEqual([createParent('root-node', [createLeaf('child-node')])]);
     });
 

package/src/hooks/useSearchableTree.ts

@@ -12,6 +12,7 @@ export type SearchResult<TTreeNode extends TreeNodeProps> = {
 
 export type SearchParams = {
   search: string;
+  expandedNodes: string[];
 };
 
 type UseSearchableTreeParams<TRecordValue, TTreeNode extends TreeNodeProps> = {
@@ -87,7 +88,9 @@ export function useSearchableTree<TRecordValue, TTreeNode extends TreeNodeProps>
       const abortController = new AbortController();
       searchAbortControllerRef.current = abortController;
 
-      const searchPromise = cancelable(onSearch({ search: searchQuery }, abortController.signal));
+      const searchPromise = cancelable(
+        onSearch({ search: searchQuery, expandedNodes: expandedNodes.current }, abortController.signal),
+      );
       searchPromiseRef.current = searchPromise;
 
       try {