@snack-uikit/list 0.4.2-preview-4dc69f78.0 → 0.4.2-preview-3bc93fc3.0

package/README.md

@@ -8,56 +8,20 @@
 
 [//]: DOCUMENTATION_SECTION_START
 [//]: THIS_SECTION_IS_AUTOGENERATED_PLEASE_DONT_EDIT_IT
-## extractChildIds
+## useFuzzySearch
+Нечеткий поиск среди айтемов по полям 'content.option', 'content.caption', 'content.description', 'label'
 ### Props
 | name | type | default value | description |
 |------|------|---------------|-------------|
-| items* | `ItemProps[]` | - |  |
-## flattenItems
+## extractChildIds
 ### Props
 | name | type | default value | description |
 |------|------|---------------|-------------|
-| __@unscopables@6987* | `{ [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@6985* | `() => IterableIterator<ItemProps>` | - | Iterator |
-| with* | `(index: number, value: ItemProps) => ItemProps[]` | - | 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: ItemProps[]): ItemProps[]; (start: number, deleteCount?: number): ItemProps[]; }` | - | 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: ItemProps, b: ItemProps) => number) => ItemProps[]` | - | 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, ASCII character order. ```ts [11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22] ``` |
-| toReversed* | `() => ItemProps[]` | - | Returns a copy of an array with its elements reversed. |
-| findLastIndex* | `(predicate: (value: ItemProps, index: number, array: ItemProps[]) => unknown, thisArg?: any) => number` | - | Returns the index of the last element in the array where predicate is true, and -1 otherwise. @param predicate findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1. @param thisArg If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |
-| findLast* | `{ <S extends ItemProps>(predicate: (value: ItemProps, index: number, array: ItemProps[]) => value is S, thisArg?: any): S; (predicate: (value: ItemProps, index: number, array: ItemProps[]) => unknown, thisArg?: any): ItemProps; }` | - | Returns the value of the last element in the array where predicate is true, and undefined otherwise. @param predicate findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined. @param thisArg If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |
-| at* | `(index: number) => ItemProps` | - | Returns the item located at the specified index. @param index The zero-based index of the desired code unit. A negative index will count back from the last item. |
-| flat* | `<A, D extends number = 1>(this: A, depth?: D) => FlatArray<A, D>[]` | - | Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. @param depth The maximum recursion depth |
-| flatMap* | `<U, This = undefined>(callback: (this: This, value: ItemProps, index: number, array: ItemProps[]) => U \| readonly U[], thisArg?: This) => U[]` | - | Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. @param callback A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. @param thisArg An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. |
-| includes* | `(searchElement: ItemProps, fromIndex?: number) => boolean` | - | Determines whether an array includes a certain element, returning true or false as appropriate. @param searchElement The element to search for. @param fromIndex The position in this array at which to begin searching for searchElement. |
-| values* | `() => IterableIterator<ItemProps>` | - | Returns an iterable of values in the array |
-| keys* | `() => IterableIterator<number>` | - | Returns an iterable of keys in the array |
-| entries* | `() => IterableIterator<[number, ItemProps]>` | - | Returns an iterable of key, value pairs for every entry in the array |
-| copyWithin* | `(target: number, start: number, end?: number) => ItemProps[]` | - | Returns the this object after copying a section of the array identified by start and end to the same array starting at position target @param target If target is negative, it is treated as length+target where length is the length of the array. @param start If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. @param end If not specified, length of the this object is used as its default value. |
-| fill* | `(value: ItemProps, start?: number, end?: number) => ItemProps[]` | - | Changes all array elements from `start` to `end` index to a static `value` and returns the modified array @param value value to fill array section with @param start index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. @param end index to stop filling the array at. If end is negative, it is treated as length+end. |
-| findIndex* | `(predicate: (value: ItemProps, index: number, obj: ItemProps[]) => unknown, thisArg?: any) => number` | - | Returns the index of the first element in the array where predicate is true, and -1 otherwise. @param predicate find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. @param thisArg If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |
-| find* | `{ <S extends ItemProps>(predicate: (value: ItemProps, index: number, obj: ItemProps[]) => value is S, thisArg?: any): S; (predicate: (value: ItemProps, index: number, obj: ItemProps[]) => unknown, thisArg?: any): ItemProps; }` | - | Returns the value of the first element in the array where predicate is true, and undefined otherwise. @param predicate find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. @param thisArg If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |
-| reduceRight* | `{ (callbackfn: (previousValue: ItemProps, currentValue: ItemProps, currentIndex: number, array: ItemProps[]) => ItemProps): ItemProps; (callbackfn: (previousValue: ItemProps, currentValue: ItemProps, currentIndex: number, array: ItemProps[]) => ItemProps, initialValue: ItemProps): ItemProps; <U>(callbackfn: (previou...` | - | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. |
-| reduce* | `{ (callbackfn: (previousValue: ItemProps, currentValue: ItemProps, currentIndex: number, array: ItemProps[]) => ItemProps): ItemProps; (callbackfn: (previousValue: ItemProps, currentValue: ItemProps, currentIndex: number, array: ItemProps[]) => ItemProps, initialValue: ItemProps): ItemProps; <U>(callbackfn: (previou...` | - | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. |
-| filter* | `{ <S extends ItemProps>(predicate: (value: ItemProps, index: number, array: ItemProps[]) => value is S, thisArg?: any): S[]; (predicate: (value: ItemProps, index: number, array: ItemProps[]) => unknown, thisArg?: any): ItemProps[]; }` | - | Returns the elements of an array that meet the condition specified in a callback function. @param predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. @param predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. |
-| map* | `<U>(callbackfn: (value: ItemProps, index: number, array: ItemProps[]) => U, thisArg?: any) => U[]` | - | Calls a defined callback function on each element of an array, and returns an array that contains the results. @param callbackfn A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |
-| forEach* | `(callbackfn: (value: ItemProps, index: number, array: ItemProps[]) => void, thisArg?: any) => void` | - | Performs the specified action for each element in an array. @param callbackfn A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |
-| some* | `(predicate: (value: ItemProps, index: number, array: ItemProps[]) => unknown, thisArg?: any) => boolean` | - | Determines whether the specified callback function returns true for any element of an array. @param predicate A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array. @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. |
-| every* | `{ <S extends ItemProps>(predicate: (value: ItemProps, index: number, array: ItemProps[]) => value is S, thisArg?: any): this is S[]; (predicate: (value: ItemProps, index: number, array: ItemProps[]) => unknown, thisArg?: any): boolean; }` | - | Determines whether all the members of an array satisfy the specified test. @param predicate A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. @param predicate A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. |
-| lastIndexOf* | `(searchElement: ItemProps, fromIndex?: number) => number` | - | Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present. @param searchElement The value to locate in the array. @param fromIndex The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array. |
-| indexOf* | `(searchElement: ItemProps, fromIndex?: number) => number` | - | Returns the index of the first occurrence of a value in an array, or -1 if it is not present. @param searchElement The value to locate in the array. @param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. |
-| unshift* | `(...items: ItemProps[]) => number` | - | Inserts new elements at the start of an array, and returns the new length of the array. @param items Elements to insert at the start of the array. |
-| splice* | `{ (start: number, deleteCount?: number): ItemProps[]; (start: number, deleteCount: number, ...items: ItemProps[]): ItemProps[]; }` | - | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. @param start The zero-based location in the array from which to start removing elements. @param deleteCount The number of elements to remove. @returns An array containing the elements that were deleted. @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 array in place of the deleted elements. @returns An array containing the elements that were deleted. |
-| sort* | `(compareFn?: (a: ItemProps, b: ItemProps) => number) => ItemProps[]` | - | Sorts an array in place. This method mutates the array and returns a reference to the same array. @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, ASCII character order. ```ts [11,2,22,1].sort((a, b) => a - b) ``` |
-| slice* | `(start?: number, end?: number) => ItemProps[]` | - | Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array. @param start The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0. @param end The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array. |
-| shift* | `() => ItemProps` | - | Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. |
-| reverse* | `() => ItemProps[]` | - | Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array. |
-| join* | `(separator?: string) => string` | - | Adds all the elements of an array into a string, separated by the specified separator string. @param separator A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma. |
-| concat* | `{ (...items: ConcatArray<ItemProps>[]): ItemProps[]; (...items: (ItemProps \| ConcatArray<ItemProps>)[]): ItemProps[]; }` | - | Combines two or more arrays. This method returns a new array without modifying any existing arrays. @param items Additional arrays and/or items to add to the end of the array. @param items Additional arrays and/or items to add to the end of the array. |
-| push* | `(...items: ItemProps[]) => number` | - | Appends new elements to the end of an array, and returns the new length of the array. @param items New elements to add to the array. |
-| pop* | `() => ItemProps` | - | Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. |
-| 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` | function toLocaleString() { [native code] } | Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. |
+| items* | `ItemProps[]` | - |  |
+## flattenItems
+`flattenItems` 
+
+Функция разворачивает массив айтемов в плоский список
 ## isAccordionItemProps
 ### Props
 | name | type | default value | description |

package/dist/hooks.d.ts

@@ -1,2 +1,5 @@
 import { ItemProps } from './components/Items';
+/**
+ * Нечеткий поиск среди айтемов по полям 'content.option', 'content.caption', 'content.description', 'label'
+ */
 export declare function useFuzzySearch(items: ItemProps[], minSearchInputLength?: number): (search: string) => ItemProps[];

package/dist/hooks.js

@@ -2,6 +2,9 @@ import FuzzySearch from 'fuzzy-search';
 import { useCallback } from 'react';
 import { flattenItems } from './utils';
 const DEFAULT_MIN_SEARCH_INPUT_LENGTH = 2;
+/**
+ * Нечеткий поиск среди айтемов по полям 'content.option', 'content.caption', 'content.description', 'label'
+ */
 export function useFuzzySearch(items, minSearchInputLength) {
     return useCallback((search) => {
         const searcher = new FuzzySearch(flattenItems(items), ['content.option', 'content.caption', 'content.description', 'label'], {});

package/dist/utils.d.ts

@@ -11,6 +11,10 @@ export declare function withCollapsedItems({ items, openCollapsedItems }: WithCo
     expandedIds: (string | number)[];
 };
 export declare function extractItemRefs(items: ItemProps[]): RefObject<HTMLElement>[];
+/**
+ * Функция возвращает массив id дочерних items
+ * @function  extractItemIds
+ */
 export declare function extractItemIds(items: ItemProps[]): Array<string | number>;
 export declare function extractChildIds({ items }: {
     items: ItemProps[];
@@ -18,5 +22,9 @@ export declare function extractChildIds({ items }: {
 export declare function extractAllChildIds({ items }: {
     items: ItemProps[];
 }): Array<string | number>;
+/**
+ *  Функция разворачивает массив айтемов в плоский список
+ *  @function  flattenItems
+ */
 export declare function flattenItems(items: ItemProps[]): (BaseItemProps | AccordionItemProps | NextListItemProps)[];
 export {};

package/dist/utils.js

@@ -46,6 +46,10 @@ export function extractItemRefs(items) {
         return item.itemRef ? prev.concat([item.itemRef]) : prev;
     }, []);
 }
+/**
+ * Функция возвращает массив id дочерних items
+ * @function  extractItemIds
+ */
 export function extractItemIds(items) {
     return items.reduce((prev, item) => {
         if (isGroupItemProps(item)) {
@@ -88,6 +92,10 @@ export function extractAllChildIds({ items }) {
         return item.id && !isGroupItemProps(item) ? prev.concat([item.id]) : prev;
     }, []);
 }
+/**
+ *  Функция разворачивает массив айтемов в плоский список
+ *  @function  flattenItems
+ */
 export function flattenItems(items) {
     const flattenedItems = [];
     function flatten(item) {

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "title": "List",
-  "version": "0.4.2-preview-4dc69f78.0",
+  "version": "0.4.2-preview-3bc93fc3.0",
   "sideEffects": [
     "*.css",
     "*.woff",
@@ -32,7 +32,7 @@
   "license": "Apache-2.0",
   "scripts": {},
   "dependencies": {
-    "@snack-uikit/divider": "3.0.1",
+    "@snack-uikit/divider": "3.0.2-preview-3bc93fc3.0",
     "@snack-uikit/dropdown": "0.2.0",
     "@snack-uikit/icons": "0.20.1",
     "@snack-uikit/info-block": "0.3.0",
@@ -54,5 +54,5 @@
   "peerDependencies": {
     "@snack-uikit/locale": "*"
   },
-  "gitHead": "a71ac782c394557f4c38cea27970d0c0e8fded26"
+  "gitHead": "a2fa7717157c8a23fa1fc6b64c67c7b2d9dfc39c"
 }

package/src/hooks.ts

@@ -6,6 +6,9 @@ import { flattenItems } from './utils';
 
 const DEFAULT_MIN_SEARCH_INPUT_LENGTH = 2;
 
+/**
+ * Нечеткий поиск среди айтемов по полям 'content.option', 'content.caption', 'content.description', 'label'
+ */
 export function useFuzzySearch(items: ItemProps[], minSearchInputLength?: number) {
   return useCallback(
     (search: string) => {

package/src/utils.ts

@@ -80,6 +80,11 @@ export function extractItemRefs(items: ItemProps[]): RefObject<HTMLElement>[] {
   }, [] as RefObject<HTMLElement>[]);
 }
 
+/**
+ * Функция возвращает массив id дочерних items
+ * @function  extractItemIds
+ */
+
 export function extractItemIds(items: ItemProps[]): Array<string | number> {
   return items.reduce(
     (prev: Array<string | number>, item: ItemProps) => {
@@ -142,6 +147,11 @@ export function extractAllChildIds({ items }: { items: ItemProps[] }): Array<str
     );
 }
 
+/**
+ *  Функция разворачивает массив айтемов в плоский список
+ *  @function  flattenItems
+ */
+
 export function flattenItems(items: ItemProps[]): (BaseItemProps | AccordionItemProps | NextListItemProps)[] {
   const flattenedItems: (BaseItemProps | AccordionItemProps | NextListItemProps)[] = [];