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

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

@@ -0,0 +1,23 @@
+# @topvisor/ui
+
+## Modules
+
+| Module | Description |
+| ------ | ------ |
+| [check](?path=/docs/core-utils-references-check-Docs--docs) | Функции для проверки данных |
+| [clipboard](?path=/docs/core-utils-references-clipboard-Docs--docs) | Работа с буфером обмена |
+| [date](?path=/docs/core-utils-references-date-Docs--docs) | Работа с датами |
+| [device](?path=/docs/core-utils-references-device-Docs--docs) | Получение информации об устройстве |
+| [dom](?path=/docs/core-utils-references-dom-Docs--docs) | Работа с Document Object Model (DOM) |
+| [image](?path=/docs/core-utils-references-image-Docs--docs) | Работа с изображениями |
+| [keyboard](?path=/docs/core-utils-references-keyboard-Docs--docs) | Утилиты для работы с устройствами ввода |
+| [lodash](?path=/docs/core-utils-references-lodash-Docs--docs) | Сборка lodash только с необходимыми функциями |
+| [number](?path=/docs/core-utils-references-number-Docs--docs) | Работа с числами |
+| [price](?path=/docs/core-utils-references-price-Docs--docs) | Работа с ценами |
+| [route](?path=/docs/core-utils-references-route-Docs--docs) | Управление навигацией страницы, работа с hash параметрами страницы |
+| [scroll](?path=/docs/core-utils-references-scroll-Docs--docs) | Информация о скролле, фичи для скролла |
+| [searchers](?path=/docs/core-utils-references-searchers-Docs--docs) | - |
+| [store](?path=/docs/core-utils-references-store-Docs--docs) | Локальное храналище компонента, альтернатива глобальному Pinia |
+| [string](?path=/docs/core-utils-references-string-Docs--docs) | Работа со строками |
+| [system](?path=/docs/core-utils-references-system-Docs--docs) | Системные утилиты |
+| [url](?path=/docs/core-utils-references-url-Docs--docs) | Работа с урлами |

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

@@ -0,0 +1,15 @@
+# check
+
+Функции для проверки данных
+
+## Index
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [getDomainRegexp](?path=/docs/core-utils-references-check-functions-getDomainRegexp--docs) | Получить строку с регулярным выражение для домена |
+| [isDomain](?path=/docs/core-utils-references-check-functions-isDomain--docs) | Проверка валидности домена |
+| [isEmail](?path=/docs/core-utils-references-check-functions-isEmail--docs) | Проверка валидности email |
+| [isIp](?path=/docs/core-utils-references-check-functions-isIp--docs) | Проверка валидности ip |
+| [validUrl](?path=/docs/core-utils-references-check-functions-validUrl--docs) | Проверка валидности URL-адреса |

package/src/core/utils/References/check/functions/getDomainRegexp.mdx

@@ -0,0 +1,15 @@
+# Function: getDomainRegexp()
+
+```ts
+function getDomainRegexp(): string
+```
+
+Получить строку с регулярным выражение для домена
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/check.ts:26

package/src/core/utils/References/check/functions/isDomain.mdx

@@ -0,0 +1,21 @@
+# Function: isDomain()
+
+```ts
+function isDomain(domain): boolean
+```
+
+Проверка валидности домена
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `domain` | `string` |
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+src/core/utils/check.ts:72

package/src/core/utils/References/check/functions/isEmail.mdx

@@ -0,0 +1,22 @@
+# Function: isEmail()
+
+```ts
+function isEmail(email, rus_allow): boolean
+```
+
+Проверка валидности email
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `email` | `string` | `undefined` |  |
+| `rus_allow` | `boolean` | `false` | если true, русскоязычные адреса тоже будут валидны |
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+src/core/utils/check.ts:38

package/src/core/utils/References/check/functions/isIp.mdx

@@ -0,0 +1,21 @@
+# Function: isIp()
+
+```ts
+function isIp(ip): boolean
+```
+
+Проверка валидности ip
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `ip` | `string` |
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+src/core/utils/check.ts:83

package/src/core/utils/References/check/functions/validUrl.mdx

@@ -0,0 +1,22 @@
+# Function: validUrl()
+
+```ts
+function validUrl(url, allowIP): boolean
+```
+
+Проверка валидности URL-адреса
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `url` | `string` | `undefined` |
+| `allowIP` | `boolean` | `false` |
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+src/core/utils/check.ts:56

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

@@ -0,0 +1,11 @@
+# clipboard
+
+Работа с буфером обмена
+
+## Index
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [setClipboard](?path=/docs/core-utils-references-clipboard-functions-setClipboard--docs) | Скопировать текст в буфер омбена |

package/src/core/utils/References/clipboard/functions/setClipboard.mdx

@@ -0,0 +1,23 @@
+# Function: setClipboard()
+
+```ts
+function setClipboard(text): Promise<void>
+```
+
+Скопировать текст в буфер омбена
+
+Формат: text/plain
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `text` | `any` |
+
+## Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;`void`&gt;
+
+## Defined in
+
+src/core/utils/clipboard.ts:11

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

@@ -0,0 +1,17 @@
+# date
+
+Работа с датами
+
+## Index
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [dateFormat](?path=/docs/core-utils-references-date-functions-dateFormat--docs) | Перевод даты в формат пользователя |
+| [dateToString](?path=/docs/core-utils-references-date-functions-dateToString--docs) | Преобразовать дату в строку формата Y-m-d H:i:s |
+| [dateUnformat](?path=/docs/core-utils-references-date-functions-dateUnformat--docs) | Перевод даты из формата пользователя в системный формат Y-m-d H:i:s |
+| [genDate](?path=/docs/core-utils-references-date-functions-genDate--docs) | Генерация даты-строки из миллисекунд (UTC), в формате Y-m-d H:i:s |
+| [genDateMoscow](?path=/docs/core-utils-references-date-functions-genDateMoscow--docs) | Генерация даты-строки (время московское) из миллисекунд (UTC), в формате Y-m-d H:i:s |
+| [getDayOfWeek](?path=/docs/core-utils-references-date-functions-getDayOfWeek--docs) | Получить день недели |
+| [stringToDate](?path=/docs/core-utils-references-date-functions-stringToDate--docs) | Получить объект Date из строки |

package/src/core/utils/References/date/functions/dateFormat.mdx

@@ -0,0 +1,28 @@
+# Function: dateFormat()
+
+```ts
+function dateFormat(
+   dateMixed, 
+   time, 
+   dateFormat?, 
+   emptyValue?): string
+```
+
+Перевод даты в формат пользователя
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `dateMixed` | `string` \| [`Date`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date) | `undefined` | объект даты или строка в формате Y-m-d H:i:s |
+| `time` | `0` \| `1` \| `2` \| `3` | `2` | 0-только дата | 1-дата и часы | 2-дата и часы с минутами | 3-дата и часы с минутами и секундами |
+| `dateFormat`? | `string` | `undefined` |  |
+| `emptyValue`? | `string` | `undefined` | значение, которое надо вернуть, если дата не указана |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/date.ts:160

package/src/core/utils/References/date/functions/dateToString.mdx

@@ -0,0 +1,26 @@
+# Function: dateToString()
+
+```ts
+function dateToString(
+   dateObject, 
+   langFormat, 
+   timeFormat): string
+```
+
+Преобразовать дату в строку формата Y-m-d H:i:s
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `dateObject` | [`Date`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date) | `undefined` | объект Date |
+| `langFormat` | `boolean` | `true` | если true, формат даты будет взят из Core.state.dateFormat |
+| `timeFormat` | `0` \| `1` \| `2` \| `3` | `2` | 0-только дата | 1-дата и часы | 2-дата и часы с минутами | 3-дата и часы с минутами и секундами |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/date.ts:41

package/src/core/utils/References/date/functions/dateUnformat.mdx

@@ -0,0 +1,22 @@
+# Function: dateUnformat()
+
+```ts
+function dateUnformat(date, emptyValue?): string
+```
+
+Перевод даты из формата пользователя в системный формат Y-m-d H:i:s
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `date` | `string` | строка с датой |
+| `emptyValue`? | `string` | значение, которое надо вернуть, если дата не указана |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/date.ts:245

package/src/core/utils/References/date/functions/genDate.mdx

@@ -0,0 +1,26 @@
+# Function: genDate()
+
+```ts
+function genDate(
+   timestamp, 
+   useFormat, 
+   time): string
+```
+
+Генерация даты-строки из миллисекунд (UTC), в формате Y-m-d H:i:s
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `timestamp` | `undefined` \| `number` | `undefined` | дата в мс, если не передана, берется дата на момент вызова функции |
+| `useFormat` | `boolean` | `true` | если true, формат даты будет взят из Core.state.dateFormat |
+| `time` | \| `0` \| `1` \| `3` \| `2` \| `"auto"` | `0` | 0: только дата - 1: дата часы - 2: дата и часы с минутами - 3: дата и часы с минутами и секундами - auto: часы и минуты будут выводиться только, если они не равны нулю |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/date.ts:85

package/src/core/utils/References/date/functions/genDateMoscow.mdx

@@ -0,0 +1,22 @@
+# Function: genDateMoscow()
+
+```ts
+function genDateMoscow(ms, useFormat): string
+```
+
+Генерация даты-строки (время московское) из миллисекунд (UTC), в формате Y-m-d H:i:s
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `ms` | `undefined` \| `number` | `undefined` | дата в мс, если не передана, берется дата на момент вызова функции |
+| `useFormat` | `boolean` | `true` | - |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/date.ts:124

package/src/core/utils/References/date/functions/getDayOfWeek.mdx

@@ -0,0 +1,26 @@
+# Function: getDayOfWeek()
+
+```ts
+function getDayOfWeek(
+   y, 
+   m, 
+   d): string
+```
+
+Получить день недели
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `y` | `number` |
+| `m` | `number` |
+| `d` | `number` |
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/date.ts:12

package/src/core/utils/References/date/functions/stringToDate.mdx

@@ -0,0 +1,21 @@
+# Function: stringToDate()
+
+```ts
+function stringToDate(date): Date
+```
+
+Получить объект Date из строки
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `date` | `string` | строка с датой |
+
+## Returns
+
+[`Date`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date)
+
+## Defined in
+
+src/core/utils/date.ts:62

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

@@ -0,0 +1,21 @@
+# device
+
+Получение информации об устройстве
+
+## Index
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [get$scroll](?path=/docs/core-utils-references/device/functions/get$scroll.mdx) | Вернуть контейнеры со скроллом (требует jquery) |
+| [getCommandKeyLabel](?path=/docs/core-utils-references-device-functions-getCommandKeyLabel--docs) | Вернуть текст для обозначения клавиши Ctrl / Command в зависимости от OS |
+| [getElsScroll](?path=/docs/core-utils-references-device-functions-getElsScroll--docs) | Вернуть контейнеры со скроллом (без jquery) |
+| [getOS](?path=/docs/core-utils-references-device-functions-getOS--docs) | Получить операционную систему пользователя |
+| [getOSAsync](?path=/docs/core-utils-references-device-functions-getOSAsync--docs) | Получить операционную систему пользователя, в том числе Windows 11 |
+| [getScrollTop](?path=/docs/core-utils-references-device-functions-getScrollTop--docs) | Вернуть скролл с учетом устройства |
+| [isApp](?path=/docs/core-utils-references-device-functions-isApp--docs) | Определить, открыт ли сайт в приложении |
+| [isMacOS](?path=/docs/core-utils-references-device-functions-isMacOS--docs) | Определить, является ли OS пользователя macOS |
+| [isMobile](?path=/docs/core-utils-references-device-functions-isMobile--docs) | Определить, является ли устройство мобильным |
+| [isRetina](?path=/docs/core-utils-references-device-functions-isRetina--docs) | Определить, увеличинная ли плотность пикселей у экрана (DPR > 1) |
+| [isSafari](?path=/docs/core-utils-references-device-functions-isSafari--docs) | Определить, является ли текущий браузер пользователя Safari |

package/src/core/utils/References/device/functions/get$scroll.mdx

@@ -0,0 +1,15 @@
+# Function: get$scroll()
+
+```ts
+function get$scroll(): JQuery<Document>
+```
+
+Вернуть контейнеры со скроллом (требует jquery)
+
+## Returns
+
+`JQuery`&lt;[`Document`](https://developer.mozilla.org/docs/Web/API/Document)&gt;
+
+## Defined in
+
+src/core/utils/device.ts:69

package/src/core/utils/References/device/functions/getCommandKeyLabel.mdx

@@ -0,0 +1,15 @@
+# Function: getCommandKeyLabel()
+
+```ts
+function getCommandKeyLabel(): "Ctrl" | "⌘"
+```
+
+Вернуть текст для обозначения клавиши Ctrl / Command в зависимости от OS
+
+## Returns
+
+`"Ctrl"` \| `"⌘"`
+
+## Defined in
+
+src/core/utils/device.ts:51

package/src/core/utils/References/device/functions/getElsScroll.mdx

@@ -0,0 +1,15 @@
+# Function: getElsScroll()
+
+```ts
+function getElsScroll(): Document[]
+```
+
+Вернуть контейнеры со скроллом (без jquery)
+
+## Returns
+
+[`Document`](https://developer.mozilla.org/docs/Web/API/Document)[]
+
+## Defined in
+
+src/core/utils/device.ts:76

package/src/core/utils/References/device/functions/getOS.mdx

@@ -0,0 +1,17 @@
+# Function: getOS()
+
+```ts
+function getOS(): string
+```
+
+Получить операционную систему пользователя
+
+Не определяет Windows 11, см. getOSAsync()
+
+## Returns
+
+`string`
+
+## Defined in
+
+src/core/utils/device.ts:85

package/src/core/utils/References/device/functions/getOSAsync.mdx

@@ -0,0 +1,15 @@
+# Function: getOSAsync()
+
+```ts
+function getOSAsync(): Promise<string>
+```
+
+Получить операционную систему пользователя, в том числе Windows 11
+
+## Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;`string`&gt;
+
+## Defined in
+
+src/core/utils/device.ts:127

package/src/core/utils/References/device/functions/getScrollTop.mdx

@@ -0,0 +1,15 @@
+# Function: getScrollTop()
+
+```ts
+function getScrollTop(): undefined | number
+```
+
+Вернуть скролл с учетом устройства
+
+## Returns
+
+`undefined` \| `number`
+
+## Defined in
+
+src/core/utils/device.ts:62

package/src/core/utils/References/device/functions/isApp.mdx

@@ -0,0 +1,15 @@
+# Function: isApp()
+
+```ts
+function isApp(): boolean
+```
+
+Определить, открыт ли сайт в приложении
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+src/core/utils/device.ts:23

package/src/core/utils/References/device/functions/isMacOS.mdx

@@ -0,0 +1,15 @@
+# Function: isMacOS()
+
+```ts
+function isMacOS(): boolean
+```
+
+Определить, является ли OS пользователя macOS
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+src/core/utils/device.ts:30

package/src/core/utils/References/device/functions/isMobile.mdx

@@ -0,0 +1,15 @@
+# Function: isMobile()
+
+```ts
+function isMobile(): boolean
+```
+
+Определить, является ли устройство мобильным
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+src/core/utils/device.ts:16

package/src/core/utils/References/device/functions/isRetina.mdx

@@ -0,0 +1,15 @@
+# Function: isRetina()
+
+```ts
+function isRetina(): boolean
+```
+
+Определить, увеличинная ли плотность пикселей у экрана (DPR > 1)
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+src/core/utils/device.ts:9

package/src/core/utils/References/device/functions/isSafari.mdx

@@ -0,0 +1,15 @@
+# Function: isSafari()
+
+```ts
+function isSafari(): boolean
+```
+
+Определить, является ли текущий браузер пользователя Safari
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+src/core/utils/device.ts:37

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

@@ -0,0 +1,27 @@
+# dom
+
+Работа с Document Object Model (DOM)
+
+## Index
+
+### Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [default](?path=/docs/core-utils-references-dom-variables-default--docs) | - |
+
+### Functions
+
+| Function | Description |
+| ------ | ------ |
+| [css](?path=/docs/core-utils-references-dom-functions-css--docs) | Получить значение css свойства элемента |
+| [genEl](?path=/docs/core-utils-references-dom-functions-genEl--docs) | Создать элемент |
+| [isVisible](?path=/docs/core-utils-references-dom-functions-isVisible--docs) | Проверить видимость элемента |
+| [offset](?path=/docs/core-utils-references-dom-functions-offset--docs) | Получить координаты элемента относительно документа |
+| [querySelectorAllArray](?path=/docs/core-utils-references-dom-functions-querySelectorAllArray--docs) | Найти элементы и вернуть в виде массива |
+| [querySelectorAllVisible](?path=/docs/core-utils-references-dom-functions-querySelectorAllVisible--docs) | Найти видимые элементы |
+| [querySelectorVisible](?path=/docs/core-utils-references-dom-functions-querySelectorVisible--docs) | Найти и вернуть первый видимый элемент |
+| [querySelectorVisibleLast](?path=/docs/core-utils-references-dom-functions-querySelectorVisibleLast--docs) | Найти и вернуть последний видимый элемент |
+| [storage](?path=/docs/core-utils-references-dom-functions-storage--docs) | Хранилище данных элемента |
+| [storageClear](?path=/docs/core-utils-references-dom-functions-storageClear--docs) | Очистить хранилище элемента |
+| [wrap](?path=/docs/core-utils-references-dom-functions-wrap--docs) | Обернуть элемент и вернуть только что созданный элемент |

package/src/core/utils/References/dom/functions/css.mdx

@@ -0,0 +1,24 @@
+# Function: css()
+
+```ts
+function css(el, property): string
+```
+
+Получить значение css свойства элемента
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `el` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) |  |
+| `property` | `string` | имя свойства |
+
+## Returns
+
+`string`
+
+- значение css стиля
+
+## Defined in
+
+src/core/utils/dom.ts:70