@topvisor/ui 1.0.22-test-ci-cd-10 → 1.2.0

package/src/core/utils/References/lodash/functions/debounce.mdx

@@ -0,0 +1,76 @@
+# Function: debounce()
+
+## debounce(func, wait, options)
+
+```ts
+function debounce<T>(
+   func, 
+   wait, 
+   options): DebouncedFuncLeading<T>
+```
+
+Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since
+the last time the debounced function was invoked. The debounced function comes with a cancel method to
+cancel delayed invocations and a flush method to immediately invoke them. Provide an options object to
+indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent
+calls to the debounced function return the result of the last func invocation.
+
+Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only
+if the the debounced function is invoked more than once during the wait timeout.
+
+See David Corbacho’s article for details over the differences between _.debounce and _.throttle.
+
+### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* (...`args`) => `any` |
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `func` | `T` | The function to debounce. |
+| `wait` | `undefined` \| `number` | The number of milliseconds to delay. |
+| `options` | `DebounceSettingsLeading` | The options object. |
+
+### Returns
+
+`DebouncedFuncLeading`&lt;`T`&gt;
+
+Returns the new debounced function.
+
+### Defined in
+
+node\_modules/@types/lodash/common/function.d.ts:425
+
+## debounce(func, wait, options)
+
+```ts
+function debounce<T>(
+   func, 
+   wait?, 
+   options?): DebouncedFunc<T>
+```
+
+### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* (...`args`) => `any` |
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `func` | `T` |
+| `wait`? | `number` |
+| `options`? | `DebounceSettings` |
+
+### Returns
+
+`DebouncedFunc`&lt;`T`&gt;
+
+### Defined in
+
+node\_modules/@types/lodash/common/function.d.ts:426

package/src/core/utils/References/lodash/functions/memoize.mdx

@@ -0,0 +1,26 @@
+# Function: memoize()
+
+```ts
+function memoize<T>(func, resolver?): T & MemoizedFunction
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* (...`args`) => `any` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `func` | `T` |
+| `resolver`? | (...`args`) => `any` |
+
+## Returns
+
+`T` & `MemoizedFunction`
+
+## Defined in
+
+node\_modules/@types/lodash/common/function.d.ts:548

package/src/core/utils/References/lodash/functions/merge.mdx

@@ -0,0 +1,200 @@
+# Function: merge()
+
+## merge(object, source)
+
+```ts
+function merge<TObject, TSource>(object, source): TObject & TSource
+```
+
+Recursively merges own and inherited enumerable properties of source
+objects into the destination object, skipping source properties that resolve
+to `undefined`. Array and plain object properties are merged recursively.
+Other objects and value types are overridden by assignment. Source objects
+are applied from left to right. Subsequent sources overwrite property
+assignments of previous sources.
+
+**Note:** This method mutates `object`.
+
+### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TObject` |
+| `TSource` |
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `object` | `TObject` | The destination object. |
+| `source` | `TSource` | - |
+
+### Returns
+
+`TObject` & `TSource`
+
+Returns `object`.
+
+### Example
+
+```ts
+var users = {
+  'data': [{ 'user': 'barney' }, { 'user': 'fred' }]
+};
+
+var ages = {
+  'data': [{ 'age': 36 }, { 'age': 40 }]
+};
+
+_.merge(users, ages);
+// => { 'data': [{ 'user': 'barney', 'age': 36 }, { 'user': 'fred', 'age': 40 }] }
+```
+
+### Defined in
+
+node\_modules/@types/lodash/common/object.d.ts:1838
+
+## merge(object, source1, source2)
+
+```ts
+function merge<TObject, TSource1, TSource2>(
+   object, 
+   source1, 
+   source2): TObject & TSource1 & TSource2
+```
+
+### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TObject` |
+| `TSource1` |
+| `TSource2` |
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `object` | `TObject` |
+| `source1` | `TSource1` |
+| `source2` | `TSource2` |
+
+### Returns
+
+`TObject` & `TSource1` & `TSource2`
+
+### See
+
+_.merge
+
+### Defined in
+
+node\_modules/@types/lodash/common/object.d.ts:1842
+
+## merge(object, source1, source2, source3)
+
+```ts
+function merge<TObject, TSource1, TSource2, TSource3>(
+   object, 
+   source1, 
+   source2, 
+   source3): TObject & TSource1 & TSource2 & TSource3
+```
+
+### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TObject` |
+| `TSource1` |
+| `TSource2` |
+| `TSource3` |
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `object` | `TObject` |
+| `source1` | `TSource1` |
+| `source2` | `TSource2` |
+| `source3` | `TSource3` |
+
+### Returns
+
+`TObject` & `TSource1` & `TSource2` & `TSource3`
+
+### See
+
+_.merge
+
+### Defined in
+
+node\_modules/@types/lodash/common/object.d.ts:1846
+
+## merge(object, source1, source2, source3, source4)
+
+```ts
+function merge<TObject, TSource1, TSource2, TSource3, TSource4>(
+   object, 
+   source1, 
+   source2, 
+   source3, 
+   source4): TObject & TSource1 & TSource2 & TSource3 & TSource4
+```
+
+### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TObject` |
+| `TSource1` |
+| `TSource2` |
+| `TSource3` |
+| `TSource4` |
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `object` | `TObject` |
+| `source1` | `TSource1` |
+| `source2` | `TSource2` |
+| `source3` | `TSource3` |
+| `source4` | `TSource4` |
+
+### Returns
+
+`TObject` & `TSource1` & `TSource2` & `TSource3` & `TSource4`
+
+### See
+
+_.merge
+
+### Defined in
+
+node\_modules/@types/lodash/common/object.d.ts:1850
+
+## merge(object, otherArgs)
+
+```ts
+function merge(object, ...otherArgs): any
+```
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `object` | `any` |
+| ...`otherArgs` | `any`[] |
+
+### Returns
+
+`any`
+
+### See
+
+_.merge
+
+### Defined in
+
+node\_modules/@types/lodash/common/object.d.ts:1854

package/src/core/utils/References/lodash/functions/throttle.mdx

@@ -0,0 +1,73 @@
+# Function: throttle()
+
+## throttle(func, wait, options)
+
+```ts
+function throttle<T>(
+   func, 
+   wait?, 
+   options?): DebouncedFuncLeading<T>
+```
+
+Creates a throttled function that only invokes func at most once per every wait milliseconds. The throttled
+function comes with a cancel method to cancel delayed invocations and a flush method to immediately invoke
+them. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge
+of the wait timeout. Subsequent calls to the throttled function return the result of the last func call.
+
+Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if
+the the throttled function is invoked more than once during the wait timeout.
+
+### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* (...`args`) => `any` |
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `func` | `T` | The function to throttle. |
+| `wait`? | `number` | The number of milliseconds to throttle invocations to. |
+| `options`? | `ThrottleSettingsLeading` | The options object. |
+
+### Returns
+
+`DebouncedFuncLeading`&lt;`T`&gt;
+
+Returns the new throttled function.
+
+### Defined in
+
+node\_modules/@types/lodash/common/function.d.ts:1375
+
+## throttle(func, wait, options)
+
+```ts
+function throttle<T>(
+   func, 
+   wait?, 
+   options?): DebouncedFunc<T>
+```
+
+### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* (...`args`) => `any` |
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `func` | `T` |
+| `wait`? | `number` |
+| `options`? | `ThrottleSettings` |
+
+### Returns
+
+`DebouncedFunc`&lt;`T`&gt;
+
+### Defined in
+
+node\_modules/@types/lodash/common/function.d.ts:1376

package/src/core/utils/References/number/Docs.mdx

@@ -0,0 +1,11 @@
+# number
+
+Работа с числами
+
+## Index
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [percentOfNumber](?path=/docs/core-utils-references-number-functions-percentOfNumber--docs) | Посчитать процент от числа (сколько процентов составляет part от full) |

package/src/core/utils/References/number/functions/percentOfNumber.mdx

@@ -0,0 +1,26 @@
+# Function: percentOfNumber()
+
+```ts
+function percentOfNumber(
+   part, 
+   full, 
+   precision): number | "--"
+```
+
+Посчитать процент от числа (сколько процентов составляет part от full)
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `part` | `number` \| `"--"` | `undefined` | первое число |
+| `full` | `number` | `100` | второе число |
+| `precision` | `number` | `0` | точность (колличество знаков после запятой) |
+
+## Returns
+
+`number` \| `"--"`
+
+## Defined in
+
+src/core/utils/number.ts:12

package/src/core/utils/References/price/Docs.mdx

@@ -0,0 +1,11 @@
+# price
+
+Работа с ценами
+
+## Index
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [genPrice](?path=/docs/core-utils-references-price-functions-genPrice--docs) | Сгенерировать строку с суммой и валютой |

package/src/core/utils/References/price/functions/genPrice.mdx

@@ -0,0 +1,28 @@
+# Function: genPrice()
+
+```ts
+function genPrice(
+   sum, 
+   lang?, 
+   currency?): string
+```
+
+Сгенерировать строку с суммой и валютой
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `sum` | `number` | `undefined` | сумма |
+| `lang`? | `Lang` | `undefined` | язык, берётся из профиля, если не задано |
+| `currency`? | `"USD"` \| `"RUB"` \| `"EUR"` | `Core.state.currency` | валюта, берётся из профиля, если не задано |
+
+## Returns
+
+`string`
+
+строка с языкозависимым представлением числа sum и знаком валюты
+
+## Defined in
+
+src/core/utils/price.ts:17

package/src/core/utils/References/route/Docs.mdx

@@ -0,0 +1,16 @@
+# route
+
+Управление навигацией страницы, работа с hash параметрами страницы
+
+## Index
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [delHash](?path=/docs/core-utils-references-route-functions-delHash--docs) | Удалить значение из хэш параметра страницы |
+| [genHash](?path=/docs/core-utils-references-route-functions-genHash--docs) | Сгенерировать новое значение для хэш параметра страницы с указанным параметром |
+| [getHash](?path=/docs/core-utils-references-route-functions-getHash--docs) | Получить значение хэш параметра страницы |
+| [historySetState](?path=/docs/core-utils-references-route-functions-historySetState--docs) | Установть позицию в истории вкладки браузера |
+| [setHash](?path=/docs/core-utils-references-route-functions-setHash--docs) | Установить значение в хэш параметр страницы |
+| [setHashs](?path=/docs/core-utils-references-route-functions-setHashs--docs) | Установить значения в хэш параметр страницы |

package/src/core/utils/References/route/functions/delHash.mdx

@@ -0,0 +1,26 @@
+# Function: delHash()
+
+```ts
+function delHash(
+   name, 
+   value, 
+   replaceState): void
+```
+
+Удалить значение из хэш параметра страницы
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `name` | `string` | `undefined` |
+| `value` | `string` | `undefined` |
+| `replaceState` | `boolean` | `true` |
+
+## Returns
+
+`void`
+
+## Defined in
+
+src/core/utils/route.ts:37

package/src/core/utils/References/route/functions/genHash.mdx

@@ -0,0 +1,26 @@
+# Function: genHash()
+
+```ts
+function genHash(
+   name, 
+   value, 
+   locationHash): string
+```
+
+Сгенерировать новое значение для хэш параметра страницы с указанным параметром
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `name` | `string` | `undefined` |
+| `value` | `null` \| `string` \| `number` | `undefined` |
+| `locationHash` | `string` | `location.hash` |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/route.ts:44

package/src/core/utils/References/route/functions/getHash.mdx

@@ -0,0 +1,22 @@
+# Function: getHash()
+
+```ts
+function getHash(name, locationHash): string
+```
+
+Получить значение хэш параметра страницы
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `name` | `string` | `undefined` |
+| `locationHash` | `string` | `location.hash` |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/route.ts:9

package/src/core/utils/References/route/functions/historySetState.mdx

@@ -0,0 +1,31 @@
+# Function: historySetState()
+
+```ts
+function historySetState(replace, hash): void
+```
+
+Установть позицию в истории вкладки браузера
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `replace` | `boolean` | `false` |
+| `hash` | `string` | `undefined` |
+
+## Returns
+
+`void`
+
+## See
+
+ - history.replaceState
+ - history.pushState
+
+## Todo
+
+Мешает SPA сайта, вместо него использовать historyPushState() из @/component/vue/app/spa
+
+## Defined in
+
+src/core/utils/route.ts:109

package/src/core/utils/References/route/functions/setHash.mdx

@@ -0,0 +1,26 @@
+# Function: setHash()
+
+```ts
+function setHash(
+   name, 
+   value, 
+   replaceState): void
+```
+
+Установить значение в хэш параметр страницы
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `name` | `string` | `undefined` |
+| `value` | `null` \| `string` \| `number` | `undefined` |
+| `replaceState` | `boolean` | `true` |
+
+## Returns
+
+`void`
+
+## Defined in
+
+src/core/utils/route.ts:23

package/src/core/utils/References/route/functions/setHashs.mdx

@@ -0,0 +1,22 @@
+# Function: setHashs()
+
+```ts
+function setHashs(data, replaceState): void
+```
+
+Установить значения в хэш параметр страницы
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `any` |
+| `replaceState` | `boolean` |
+
+## Returns
+
+`void`
+
+## Defined in
+
+src/core/utils/route.ts:72

package/src/core/utils/References/scroll/Docs.mdx

@@ -0,0 +1,14 @@
+# scroll
+
+Информация о скролле, фичи для скролла
+
+## Index
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [amountScrolled](?path=/docs/core-utils-references-scroll-functions-amountScrolled--docs) | Посчитать глубину скролла (процент на сколько проскроллена страница) |
+| [connectScrollShadow](?path=/docs/core-utils-references-scroll-functions-connectScrollShadow--docs) | Добавить отображение тени при появления скролла у элемента |
+| [genHasScroll](?path=/docs/core-utils-references-scroll-functions-genHasScroll--docs) | Добавить классы модификаторов тени в зависимости от скролла элемента |
+| [getScrollPercent](?path=/docs/core-utils-references-scroll-functions-getScrollPercent--docs) | Получить прогресс скролла в процентах |

package/src/core/utils/References/scroll/functions/amountScrolled.mdx

@@ -0,0 +1,17 @@
+# Function: ~~amountScrolled()~~
+
+```ts
+function amountScrolled(): number
+```
+
+Посчитать глубину скролла (процент на сколько проскроллена страница)
+
+## Returns
+
+`number`
+
+## Deprecated
+
+## Defined in
+
+src/core/utils/scroll.ts:94

package/src/core/utils/References/scroll/functions/connectScrollShadow.mdx

@@ -0,0 +1,28 @@
+# Function: connectScrollShadow()
+
+```ts
+function connectScrollShadow(els): void
+```
+
+Добавить отображение тени при появления скролла у элемента
+
+Будут добавоены события для усатновки модификаторов тени в зависимости от скролла элемента
+
+Модификаторы:
+- top-scrollShadow
+- top-scrollShadow-started
+- top-scrollShadow-finished
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `els` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) \| [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)[] |
+
+## Returns
+
+`void`
+
+## Defined in
+
+src/core/utils/scroll.ts:70