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

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

@@ -0,0 +1,25 @@
+# Function: genHasScroll()
+
+```ts
+function genHasScroll(el): void
+```
+
+Добавить классы модификаторов тени в зависимости от скролла элемента
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `el` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) |
+
+## Returns
+
+`void`
+
+## Todo
+
+Сделать приватной
+
+## Defined in
+
+src/core/utils/scroll.ts:13

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

@@ -0,0 +1,21 @@
+# Function: getScrollPercent()
+
+```ts
+function getScrollPercent(el): number
+```
+
+Получить прогресс скролла в процентах
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `el` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | `document.documentElement` |
+
+## Returns
+
+`number`
+
+## Defined in
+
+src/core/utils/scroll.ts:101

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

@@ -0,0 +1,19 @@
+# searchers
+
+## Index
+
+### Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [searchersNames](?path=/docs/core-utils-references-searchers-variables-searchersNames--docs) | Вспомогательный класс для работы с разными Поисковиками |
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [genVolumeLabel](?path=/docs/core-utils-references-searchers-functions-genVolumeLabel--docs) | Сгенерировать заголовок типа частоты |
+| [getDeviceGIcon](?path=/docs/core-utils-references-searchers-functions-getDeviceGIcon--docs) | Получить иконку устройства (ПК, планшет, смартфон) |
+| [getLangLabel](?path=/docs/core-utils-references-searchers-functions-getLangLabel--docs) | Получить иконку языка |
+| [getSearcherGIcon](?path=/docs/core-utils-references-searchers-functions-getSearcherGIcon--docs) | Получить иконку ПС |
+| [prepareVolumeType](?path=/docs/core-utils-references-searchers-functions-prepareVolumeType--docs) | Проверить значение частоты, вернуть правильное значение частоты |

package/src/core/utils/References/searchers/functions/genVolumeLabel.mdx

@@ -0,0 +1,26 @@
+# Function: genVolumeLabel()
+
+```ts
+function genVolumeLabel(
+   label, 
+   searcherKey, 
+   volumeType): string
+```
+
+Сгенерировать заголовок типа частоты
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `label` | `string` |
+| `searcherKey` | `0` \| `1` |
+| `volumeType` | \| `1` \| `2` \| `3` \| `5` \| `6` |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/searchers.ts:133

package/src/core/utils/References/searchers/functions/getDeviceGIcon.mdx

@@ -0,0 +1,21 @@
+# Function: getDeviceGIcon()
+
+```ts
+function getDeviceGIcon(device): string
+```
+
+Получить иконку устройства (ПК, планшет, смартфон)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `device` | `string` \| `number` |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/searchers.ts:88

package/src/core/utils/References/searchers/functions/getLangLabel.mdx

@@ -0,0 +1,22 @@
+# Function: getLangLabel()
+
+```ts
+function getLangLabel(searcherKey, lang): string
+```
+
+Получить иконку языка
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `searcherKey` | `string` \| `number` |
+| `lang` | `string` |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/searchers.ts:114

package/src/core/utils/References/searchers/functions/getSearcherGIcon.mdx

@@ -0,0 +1,21 @@
+# Function: getSearcherGIcon()
+
+```ts
+function getSearcherGIcon(searcherKey): string
+```
+
+Получить иконку ПС
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `searcherKey` | `null` \| `string` \| `number` | цифра или строка с цифрой обозначающая ПС. Если null вернется иконка с глобусом |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/searchers.ts:25

package/src/core/utils/References/searchers/functions/prepareVolumeType.mdx

@@ -0,0 +1,22 @@
+# Function: prepareVolumeType()
+
+```ts
+function prepareVolumeType(searcherKey, volumeType): number
+```
+
+Проверить значение частоты, вернуть правильное значение частоты
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `searcherKey` | `number` |
+| `volumeType` | `number` |
+
+## Returns
+
+`number`
+
+## Defined in
+
+src/core/utils/searchers.ts:169

package/src/core/utils/References/searchers/variables/searchersNames.mdx

@@ -0,0 +1,97 @@
+# Variable: searchersNames
+
+```ts
+const searchersNames: object;
+```
+
+Вспомогательный класс для работы с разными Поисковиками
+
+## Type declaration
+
+### 0
+
+```ts
+0: string = 'Yandex';
+```
+
+### 1
+
+```ts
+1: string = 'Google';
+```
+
+### 101
+
+```ts
+101: string = 'VK';
+```
+
+### 102
+
+```ts
+102: string = 'Facebook';
+```
+
+### 103
+
+```ts
+103: string = 'Twitter';
+```
+
+### 2
+
+```ts
+2: string = 'go.Mail';
+```
+
+### 20
+
+```ts
+20: string = 'Yandex.com';
+```
+
+### 21
+
+```ts
+21: string = 'Yandex.com.tr';
+```
+
+### 4
+
+```ts
+4: string = 'YouTube';
+```
+
+### 5
+
+```ts
+5: string = 'Bing';
+```
+
+### 6
+
+```ts
+6: string = 'Yahoo';
+```
+
+### 7
+
+```ts
+7: string = 'Seznam';
+```
+
+### 8
+
+```ts
+8: string = 'AppStore';
+```
+
+### 9
+
+```ts
+9: string = 'GooglePlay';
+```
+
+## Defined in
+
+src/core/utils/searchers.ts:4

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

@@ -0,0 +1,18 @@
+# store
+
+Локальное храналище компонента, альтернатива глобальному Pinia
+
+## Index
+
+### Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [plugin](?path=/docs/core-utils-references-store-variables-plugin--docs) | - |
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [defineStore](?path=/docs/core-utils-references-store-functions-defineStore--docs) | Определить Store |
+| [useStore](?path=/docs/core-utils-references-store-functions-useStore--docs) | Получить State компонента |

package/src/core/utils/References/store/functions/defineStore.mdx

@@ -0,0 +1,36 @@
+# Function: defineStore()
+
+```ts
+function defineStore<T>(
+   injectionKey, 
+   setup, 
+   $id?, 
+   options?): UnwrapNestedRefs<T> & Store
+```
+
+Определить Store
+
+Следует определять на уровне корневого компонента, использующего Store
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `injectionKey` | `InjectionKey`&lt;`UnwrapNestedRefs`&lt;`T`&gt;&gt; | InjectionKey для provide / inject в области компонента |
+| `setup` | () => `object` \| `T` | Нстройки Store, см. https://pinia.vuejs.org/core-concepts/#Setup-Stores |
+| `$id`? | `string` | строковой id Store, используется в плагинах |
+| `options`? | `object` | настройки Store, используются в плагинах |
+
+## Returns
+
+`UnwrapNestedRefs`&lt;`T`&gt; & `Store`
+
+## Defined in
+
+src/core/utils/store/store.ts:26

package/src/core/utils/References/store/functions/useStore.mdx

@@ -0,0 +1,29 @@
+# Function: useStore()
+
+```ts
+function useStore<T>(injectionKey): T & Store
+```
+
+Получить State компонента
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `injectionKey` | `InjectionKey`&lt;`T`&gt; | InjectionKey для provide / inject в области компонента |
+
+## Returns
+
+`T` & `Store`
+
+- State компонента
+
+## Defined in
+
+src/core/utils/store/store.ts:51

package/src/core/utils/References/store/variables/plugin.mdx

@@ -0,0 +1,66 @@
+# Variable: plugin
+
+```ts
+plugin: object;
+```
+
+## Type declaration
+
+### defineStore()
+
+```ts
+defineStore: <T>(injectionKey, setup, $id?, options?) => UnwrapNestedRefs<T> & Store;
+```
+
+Определить Store
+
+Следует определять на уровне корневого компонента, использующего Store
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `injectionKey` | `InjectionKey`&lt;`UnwrapNestedRefs`&lt;`T`&gt;&gt; | InjectionKey для provide / inject в области компонента |
+| `setup` | () => `object` \| `T` | Нстройки Store, см. https://pinia.vuejs.org/core-concepts/#Setup-Stores |
+| `$id`? | `string` | строковой id Store, используется в плагинах |
+| `options`? | `object` | настройки Store, используются в плагинах |
+
+#### Returns
+
+`UnwrapNestedRefs`&lt;`T`&gt; & `Store`
+
+### useStore()
+
+```ts
+useStore: <T>(injectionKey) => T & Store;
+```
+
+Получить State компонента
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `injectionKey` | `InjectionKey`&lt;`T`&gt; | InjectionKey для provide / inject в области компонента |
+
+#### Returns
+
+`T` & `Store`
+
+- State компонента
+
+## Defined in
+
+src/core/utils/store/store.ts:74

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

@@ -0,0 +1,26 @@
+# string
+
+Работа со строками
+
+## Index
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [addCommasWhite](?path=/docs/core-utils-references-string-functions-addCommasWhite--docs) | Добавляет пробелы между разрядами если требуется |
+| [addLinkTags](?path=/docs/core-utils-references-string-functions-addLinkTags--docs) | Обернуть все ссылки и email в тексте в html-тег `<a>`. |
+| [camelToSnakeCase](?path=/docs/core-utils-references-string-functions-camelToSnakeCase--docs) | Пример: logHTTPCodesHundreds => log_http_codes_hundreds |
+| [ellipsis](?path=/docs/core-utils-references-string-functions-ellipsis--docs) | Обрезать текст под три точки |
+| [genFlagLinkByCountryCode](?path=/docs/core-utils-references-string-functions-genFlagLinkByCountryCode--docs) | Получить url изображения флага, по коду страны (RU, GB) |
+| [genIntHash](?path=/docs/core-utils-references-string-functions-genIntHash--docs) | Сгенерировать числовой хэш от строки для идентификатора |
+| [getRandomHash](?path=/docs/core-utils-references-string-functions-getRandomHash--docs) | Получить случайную строку |
+| [highlightHtml](?path=/docs/core-utils-references-string-functions-highlightHtml--docs) | Выделить нужное в тексте желтым цветом поиск происходит по строке fieldFilter.values[0] |
+| [htmlspecialchars](?path=/docs/core-utils-references-string-functions-htmlspecialchars--docs) | Замена html-символов (`&`, `<`, `>`, `"`, `'`) на имена литер (`&` -> `&amp;`) |
+| [isUrl](?path=/docs/core-utils-references-string-functions-isUrl--docs) | Проверить что переданная строка является URL |
+| [nl2br](?path=/docs/core-utils-references-string-functions-nl2br--docs) | Вставляет HTML-код разрыва строки перед каждым переводом строки |
+| [numberEnding](?path=/docs/core-utils-references-string-functions-numberEnding--docs) | Сгенерировать строку текста для вывода количества в разном склонении |
+| [numberWithWord](?path=/docs/core-utils-references-string-functions-numberWithWord--docs) | Перевести число без деситичной приставки в число с деситичной приставкой степеней тысячи (с параметрами по умолчанию 1255 -> '1.26 K') |
+| [rusToLatin](?path=/docs/core-utils-references-string-functions-rusToLatin--docs) | Транслитерация текста |
+| [toCapitalize](?path=/docs/core-utils-references-string-functions-toCapitalize--docs) | Перевести первую букву строки в верхний регистр |
+| [toRoditPadej](?path=/docs/core-utils-references-string-functions-toRoditPadej--docs) | Перевести строку в родительный падеж |

package/src/core/utils/References/string/functions/addCommasWhite.mdx

@@ -0,0 +1,21 @@
+# Function: addCommasWhite()
+
+```ts
+function addCommasWhite(nStr): string
+```
+
+Добавляет пробелы между разрядами если требуется
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nStr` | `string` | строка с числом |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/string.ts:40

package/src/core/utils/References/string/functions/addLinkTags.mdx

@@ -0,0 +1,23 @@
+# Function: addLinkTags()
+
+```ts
+function addLinkTags(text): string
+```
+
+Обернуть все ссылки и email в тексте в html-тег `<a>`.
+
+Для email ставиться префикс `mailto:`
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `text` | `string` |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/string.ts:279

package/src/core/utils/References/string/functions/camelToSnakeCase.mdx

@@ -0,0 +1,21 @@
+# Function: camelToSnakeCase()
+
+```ts
+function camelToSnakeCase(str): undefined | string
+```
+
+Пример: logHTTPCodesHundreds => log_http_codes_hundreds
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `str` | `string` |
+
+## Returns
+
+`undefined` \| `string`
+
+## Defined in
+
+src/core/utils/string.ts:262

package/src/core/utils/References/string/functions/ellipsis.mdx

@@ -0,0 +1,26 @@
+# Function: ellipsis()
+
+```ts
+function ellipsis(
+   string, 
+   max_length, 
+   pos): string
+```
+
+Обрезать текст под три точки
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `string` | `string` | `undefined` |  |
+| `max_length` | `number` | `undefined` | максимальное количество символов текста, остальное обрежеться |
+| `pos` | `0` \| `1` \| `2` | `1` | область обрезки 0-начало | 1-середина | 2-конец строки |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/string.ts:97

package/src/core/utils/References/string/functions/genFlagLinkByCountryCode.mdx

@@ -0,0 +1,21 @@
+# Function: genFlagLinkByCountryCode()
+
+```ts
+function genFlagLinkByCountryCode(countryCode): string
+```
+
+Получить url изображения флага, по коду страны (RU, GB)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `countryCode` | `string` |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/string.ts:269

package/src/core/utils/References/string/functions/genIntHash.mdx

@@ -0,0 +1,21 @@
+# Function: genIntHash()
+
+```ts
+function genIntHash(string): number
+```
+
+Сгенерировать числовой хэш от строки для идентификатора
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `string` | `string` |
+
+## Returns
+
+`number`
+
+## Defined in
+
+src/core/utils/string.ts:12

package/src/core/utils/References/string/functions/getRandomHash.mdx

@@ -0,0 +1,21 @@
+# Function: getRandomHash()
+
+```ts
+function getRandomHash(length): string
+```
+
+Получить случайную строку
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `length` | `number` | `20` |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/string.ts:306

package/src/core/utils/References/string/functions/highlightHtml.mdx

@@ -0,0 +1,25 @@
+# Function: highlightHtml()
+
+```ts
+function highlightHtml(text, fieldFilter): string
+```
+
+Выделить нужное в тексте желтым цветом
+поиск происходит по строке fieldFilter.values[0]
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `text` | `string` |
+| `fieldFilter` | `object` |
+| `fieldFilter.operator` | `"CONTAINS"` \| `"REGEXP"` |
+| `fieldFilter.values` | `string`[] |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/string.ts:236

package/src/core/utils/References/string/functions/htmlspecialchars.mdx

@@ -0,0 +1,21 @@
+# Function: htmlspecialchars()
+
+```ts
+function htmlspecialchars(str): string
+```
+
+Замена html-символов (`&`, `<`, `>`, `"`, `'`) на имена литер (`&` -> `&amp;`)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `str` | `string` |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/string.ts:220