@snack-uikit/utils 3.5.1-preview-53bd8747.0 → 3.5.1-preview-baf754b1.0

package/README.md

@@ -9,3 +9,88 @@
 `npm i @snack-uikit/utils`
 
 [Changelog](./CHANGELOG.md)
+
+
+[//]: DOCUMENTATION_SECTION_START
+[//]: THIS_SECTION_IS_AUTOGENERATED_PLEASE_DONT_EDIT_IT
+## useDebounce
+`React hook` 
+
+Хук задерживает выполнение функции или обновление значения до тех пор,
+пока не пройдет определенный период времени без новых вызовов.
+## useEventHandler
+`React hook` 
+
+Хук для создания обработчика событий с неизменной функцией.
+## useLayoutEffect
+`React hook` 
+
+Хук используется вместо стандартного useLayoutEffect-а,
+нужен для корректной работы SSR
+## useSwipeable
+Хук для работы с событиями свайпа
+### Props
+| name | type | default value | description |
+|------|------|---------------|-------------|
+| enabled | `boolean` | true | Включен ли свайп |
+| availableDirections | `SwipeDirections[]` | - | Направления, в которых будет работать свайп. Укажите это свойство, чтобы предотвратить конфликты и заблокировать свайп в родительских элементах по этим направлениям. |
+| onSwipedDown | `SwipeCallback` | - | Called after a DOWN swipe |
+| onSwipedLeft | `SwipeCallback` | - | Called after a LEFT swipe |
+| onSwipedRight | `SwipeCallback` | - | Called after a RIGHT swipe |
+| onSwipedUp | `SwipeCallback` | - | Called after a UP swipe |
+| onSwipeStart | `SwipeCallback` | - | Called at start of a tracked swipe. |
+| onSwiped | `SwipeCallback` | - | Called after any swipe. |
+| onSwiping | `SwipeCallback` | - | Called for each move event during a tracked swipe. |
+| onTap | `TapCallback` | - | Called after a tap. A touch under the min distance, `delta`. |
+| onTouchStartOrOnMouseDown | `TapCallback` | - | Called for `touchstart` and `mousedown`. |
+| onTouchEndOrOnMouseUp | `TapCallback` | - | Called for `touchend` and `mouseup`. |
+| delta | `ConfigurationOptionDelta` | - | Min distance(px) before a swipe starts. **Default**: `10` |
+| preventScrollOnSwipe | `boolean` | - | Prevents scroll during swipe in most cases. **Default**: `false` |
+| rotationAngle | `number` | - | Set a rotation angle. **Default**: `0` |
+| trackMouse | `boolean` | - | Track mouse input. **Default**: `false` |
+| trackTouch | `boolean` | - | Track touch input. **Default**: `true` |
+| swipeDuration | `number` | - | Allowable duration of a swipe (ms). **Default**: `Infinity` |
+| touchEventOptions | `{ passive: boolean; }` | - | Options for touch event listeners |
+## useThemeConfig
+Хук для работы с темами
+### Props
+| name | type | default value | description |
+|------|------|---------------|-------------|
+| themeMap* | `Record<T, string>` | - | Объект с указанием соответсвия темы и css-класса |
+## useValueControl
+Хук для работы с состоянием.
+Нужен для поддержки controlled/uncontrolled поведения, в зависимости от того были ли переданы входные аргументы
+### Props
+| name | type | default value | description |
+|------|------|---------------|-------------|
+| value | `TValue` | - | Значение состояния |
+| defaultValue | `TValue` | - | Значение по умолчанию |
+| onChange | `(value: TValue) => void` | - | Колбек, вызываемый на смену состояния |
+## ThemeProvider
+Провайдер, предназначенный для работы с темами
+### Props
+| name | type | default value | description |
+|------|------|---------------|-------------|
+| defaultTheme* | `string` | - | Значение темы по умолчанию |
+| themeMap* | `Record<string, string>` | - | Объект с указанием соответсвия темы и css-класса |
+| children* | `ReactNode` | - | Дети, которые будут обёрнуты в провайдер |
+## excludeSupportProps
+`helper` 
+
+Функция для исключения вспомогательных свойств (data-test-id & aria-*)
+## extractDataTestProps
+`helper` 
+
+Функция для отбора свойства data-test-id
+## extractSupportProps
+`helper` 
+
+Функция для отбора вспомогательных свойств (data-test-id & aria-*)
+## isBrowser
+`helper` 
+
+Функция проверки текущей среды выполнения кода,
+нужна для корректной работы SSR
+
+
+[//]: DOCUMENTATION_SECTION_END

package/dist/cjs/components/ThemeProvider/ThemeProvider.d.ts

@@ -1,13 +1,28 @@
 import { ReactNode } from 'react';
 type UseThemePropsWithDefaultTheme = {
+    /**
+     * Объект с указанием соответсвия темы и css-класса
+     */
     themeMap: Record<string, string>;
+    /**
+     * Значение темы по умолчанию
+     */
     defaultTheme: string;
 };
 type UseThemeProps = {
+    /**
+     * Объект с указанием соответсвия темы и css-класса
+     */
     themeMap: Record<string, string>;
 };
 export type ThemeProviderProps = {
+    /**
+     * Дети, которые будут обёрнуты в провайдер
+     */
     children: ReactNode;
 } & (UseThemePropsWithDefaultTheme | UseThemeProps);
+/**
+ * Провайдер, предназначенный для работы с темами
+ */
 export declare function ThemeProvider({ children, ...props }: ThemeProviderProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/cjs/components/ThemeProvider/ThemeProvider.js

@@ -15,6 +15,9 @@ exports.ThemeProvider = ThemeProvider;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const hooks_1 = require("../../hooks");
 const contexts_1 = require("./contexts");
+/**
+ * Провайдер, предназначенный для работы с темами
+ */
 function ThemeProvider(_a) {
   var {
       children

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

@@ -1,6 +1,6 @@
 export * from './useDebounce';
 export * from './useEventHandler';
 export * from './useIsomorphicLayoutEffect';
-export * from './useSwipe';
+export * from './useSwipeable';
 export * from './useThemeConfig';
 export * from './useValueControl';

package/dist/cjs/hooks/index.js

@@ -25,6 +25,6 @@ Object.defineProperty(exports, "__esModule", {
 __exportStar(require("./useDebounce"), exports);
 __exportStar(require("./useEventHandler"), exports);
 __exportStar(require("./useIsomorphicLayoutEffect"), exports);
-__exportStar(require("./useSwipe"), exports);
+__exportStar(require("./useSwipeable"), exports);
 __exportStar(require("./useThemeConfig"), exports);
 __exportStar(require("./useValueControl"), exports);

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

@@ -1 +1,6 @@
+/**
+ * Хук задерживает выполнение функции или обновление значения до тех пор,
+ * пока не пройдет определенный период времени без новых вызовов.
+ * @function React hook
+ */
 export declare function useDebounce(callback: () => void, timeout?: number): () => void;

package/dist/cjs/hooks/useDebounce.js

@@ -7,6 +7,11 @@ exports.useDebounce = useDebounce;
 const react_1 = require("react");
 const utils_1 = require("../utils");
 const useEventHandler_1 = require("./useEventHandler");
+/**
+ * Хук задерживает выполнение функции или обновление значения до тех пор,
+ * пока не пройдет определенный период времени без новых вызовов.
+ * @function React hook
+ */
 function useDebounce(callback) {
   let timeout = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
   const timeStampRef = (0, react_1.useRef)(0);

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

@@ -1 +1,6 @@
+/**
+ * Хук для создания обработчика событий с неизменной функцией.
+ * @function React hook
+ * @param handler коллбек события, без параметров
+ */
 export declare function useEventHandler<T extends (...args: never[]) => unknown>(handler: T): T;

package/dist/cjs/hooks/useEventHandler.js

@@ -6,6 +6,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.useEventHandler = useEventHandler;
 const react_1 = require("react");
 const useIsomorphicLayoutEffect_1 = require("./useIsomorphicLayoutEffect");
+/**
+ * Хук для создания обработчика событий с неизменной функцией.
+ * @function React hook
+ * @param handler коллбек события, без параметров
+ */
 function useEventHandler(handler) {
   const handlerRef = (0, react_1.useRef)(null);
   (0, useIsomorphicLayoutEffect_1.useLayoutEffect)(() => {

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

@@ -1,2 +1,7 @@
 import { useLayoutEffect as useLayoutEffectInternal } from 'react';
+/**
+ * Хук используется вместо стандартного useLayoutEffect-а,
+ * нужен для корректной работы SSR
+ * @function React hook
+ */
 export declare const useLayoutEffect: typeof useLayoutEffectInternal;

package/dist/cjs/hooks/useIsomorphicLayoutEffect.js

@@ -7,4 +7,9 @@ exports.useLayoutEffect = void 0;
 // eslint-disable-next-line no-restricted-imports
 const react_1 = require("react");
 const utils_1 = require("../utils");
+/**
+ * Хук используется вместо стандартного useLayoutEffect-а,
+ * нужен для корректной работы SSR
+ * @function React hook
+ */
 exports.useLayoutEffect = (0, utils_1.isBrowser)() ? react_1.useLayoutEffect : react_1.useEffect;

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

@@ -0,0 +1,21 @@
+import { SwipeableHandlers, SwipeableProps, SwipeCallback, SwipeDirections, SwipeEventData } from 'react-swipeable';
+export declare const DATA_SWIPE_DIRECTIONS_ATTRIBUTE = "data-swipe-directions";
+export type UseSwipeProps = {
+    /**
+     * Включен ли свайп
+     */
+    enabled?: boolean;
+    /**
+     * Направления, в которых будет работать свайп.
+     * Укажите это свойство, чтобы предотвратить конфликты и заблокировать свайп в родительских элементах по этим направлениям.
+     */
+    availableDirections?: SwipeDirections[];
+} & SwipeableProps;
+export type UseSwipeReturnType = SwipeableHandlers & {
+    [DATA_SWIPE_DIRECTIONS_ATTRIBUTE]?: string;
+};
+/**
+ * Хук для работы с событиями свайпа
+ */
+export declare function useSwipeable({ availableDirections, enabled, ...options }: UseSwipeProps): UseSwipeReturnType;
+export type { SwipeCallback, SwipeDirections, SwipeEventData };

package/dist/cjs/hooks/useSwipeable.js

@@ -0,0 +1,75 @@
+"use strict";
+
+var __rest = void 0 && (void 0).__rest || function (s, e) {
+  var t = {};
+  for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0) t[p] = s[p];
+  if (s != null && typeof Object.getOwnPropertySymbols === "function") for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+    if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i])) t[p[i]] = s[p[i]];
+  }
+  return t;
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DATA_SWIPE_DIRECTIONS_ATTRIBUTE = void 0;
+exports.useSwipeable = useSwipeable;
+const react_1 = require("react");
+const react_swipeable_1 = require("react-swipeable");
+exports.DATA_SWIPE_DIRECTIONS_ATTRIBUTE = 'data-swipe-directions';
+/**
+ * Хук для работы с событиями свайпа
+ */
+function useSwipeable(_a) {
+  var {
+      availableDirections,
+      enabled = true
+    } = _a,
+    options = __rest(_a, ["availableDirections", "enabled"]);
+  const canSwipe = (0, react_1.useRef)(true);
+  const onSwipeStart = eventData => {
+    var _a;
+    if (availableDirections) {
+      if (!availableDirections.includes(eventData.dir)) {
+        canSwipe.current = false;
+        return;
+      }
+      if (!options.onSwipeStart) {
+        return;
+      }
+      eventData.event.preventDefault();
+      eventData.event.stopPropagation();
+    }
+    (_a = options.onSwipeStart) === null || _a === void 0 ? void 0 : _a.call(options, eventData);
+  };
+  const onSwiping = eventData => {
+    var _a;
+    if (availableDirections) {
+      if (!canSwipe.current) {
+        return;
+      }
+      eventData.event.preventDefault();
+      eventData.event.stopPropagation();
+    }
+    (_a = options.onSwiping) === null || _a === void 0 ? void 0 : _a.call(options, eventData);
+  };
+  const onSwiped = eventData => {
+    var _a;
+    if (availableDirections) {
+      if (!canSwipe.current) {
+        canSwipe.current = true;
+        return;
+      }
+      eventData.event.preventDefault();
+      eventData.event.stopPropagation();
+    }
+    (_a = options.onSwiped) === null || _a === void 0 ? void 0 : _a.call(options, eventData);
+  };
+  const handlers = (0, react_swipeable_1.useSwipeable)(enabled ? Object.assign(Object.assign({}, options), {
+    onSwipeStart,
+    onSwiping,
+    onSwiped
+  }) : {});
+  return Object.assign(Object.assign({}, handlers), {
+    [exports.DATA_SWIPE_DIRECTIONS_ATTRIBUTE]: enabled && availableDirections ? availableDirections.join(' ') : undefined
+  });
+}

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

@@ -3,8 +3,14 @@ type UseThemePropsWithDefaultTheme<T extends string> = {
     defaultTheme: T;
 };
 type UseThemeProps<T extends string> = {
+    /**
+     * Объект с указанием соответсвия темы и css-класса
+     */
     themeMap: Record<T, string>;
 };
+/**
+ * Хук для работы с темами
+ */
 export declare function useThemeConfig<T extends string>(props: UseThemeProps<T>): {
     theme: T | undefined;
     themeClassName: string | undefined;

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

@@ -1,7 +1,20 @@
 type UseValueControl<TValue> = {
+    /**
+     * Значение состояния
+     */
     value?: TValue;
-    onChange?(value: TValue): void;
+    /**
+     * Значение по умолчанию
+     */
     defaultValue?: TValue;
+    /**
+     * Колбек, вызываемый на смену состояния
+     */
+    onChange?(value: TValue): void;
 };
+/**
+ * Хук для работы с состоянием.
+ * Нужен для поддержки controlled/uncontrolled поведения, в зависимости от того были ли переданы входные аргументы
+ */
 export declare function useValueControl<TValue>({ value, onChange, defaultValue }: UseValueControl<TValue>): readonly [TValue | undefined, (value: any, ...args: any[]) => ReturnType<import("uncontrollable").Handler> | void];
 export {};

package/dist/cjs/hooks/useValueControl.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.useValueControl = useValueControl;
 const uncontrollable_1 = require("uncontrollable");
+/**
+ * Хук для работы с состоянием.
+ * Нужен для поддержки controlled/uncontrolled поведения, в зависимости от того были ли переданы входные аргументы
+ */
 function useValueControl(_ref) {
   let {
     value,

package/dist/cjs/index.d.ts

@@ -1,4 +1,4 @@
 export * from './hooks';
-export * from './utils';
 export * from './components';
+export * from './utils';
 export * from './types';

package/dist/cjs/index.js

@@ -23,6 +23,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 __exportStar(require("./hooks"), exports);
-__exportStar(require("./utils"), exports);
 __exportStar(require("./components"), exports);
+__exportStar(require("./utils"), exports);
 __exportStar(require("./types"), exports);

package/dist/cjs/types/index.d.ts

@@ -1 +1,5 @@
+/**
+ * Utility-тип, преобразующий константные значения объекта в union
+ * @function type
+ */
 export type ValueOf<T> = T[keyof T];

package/dist/cjs/utils/componentPropsProcessors.d.ts

@@ -2,6 +2,18 @@ import { AriaAttributes } from 'react';
 export type WithSupportProps<T> = {
     'data-test-id'?: string;
 } & AriaAttributes & T;
+/**
+ * Функция для исключения вспомогательных свойств (data-test-id & aria-*)
+ * @function helper
+ */
 export declare function excludeSupportProps<T extends Record<string, unknown>>(props: T): {};
+/**
+ * Функция для отбора свойства data-test-id
+ * @function helper
+ */
 export declare function extractDataTestProps<T extends Record<string, unknown>>(props: T): Record<string, unknown>;
+/**
+ * Функция для отбора вспомогательных свойств (data-test-id & aria-*)
+ * @function helper
+ */
 export declare function extractSupportProps<T extends Record<string, unknown>>(props: T): Record<string, unknown>;

package/dist/cjs/utils/componentPropsProcessors.js

@@ -19,12 +19,24 @@ function extractProps(props, regex) {
     return nextProps;
   }, {});
 }
+/**
+ * Функция для исключения вспомогательных свойств (data-test-id & aria-*)
+ * @function helper
+ */
 function excludeSupportProps(props) {
   return excludeProps(props, DATA_AND_ARIA_REGEXP);
 }
+/**
+ * Функция для отбора свойства data-test-id
+ * @function helper
+ */
 function extractDataTestProps(props) {
   return extractProps(props, DATA_TEST_REGEXP);
 }
+/**
+ * Функция для отбора вспомогательных свойств (data-test-id & aria-*)
+ * @function helper
+ */
 function extractSupportProps(props) {
   return extractProps(props, DATA_AND_ARIA_REGEXP);
 }

package/dist/cjs/utils/isBrowser.d.ts

@@ -1 +1,6 @@
+/**
+ * Функция проверки текущей среды выполнения кода,
+ * нужна для корректной работы SSR
+ * @function helper
+ */
 export declare function isBrowser(): boolean;

package/dist/cjs/utils/isBrowser.js

@@ -4,6 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isBrowser = isBrowser;
+/**
+ * Функция проверки текущей среды выполнения кода,
+ * нужна для корректной работы SSR
+ * @function helper
+ */
 function isBrowser() {
   // eslint-disable-next-line @cloud-ru/ssr-safe-react/domApi
   return Boolean(typeof window !== 'undefined' && window.document && window.document.createElement);

package/dist/esm/components/ThemeProvider/ThemeProvider.d.ts

@@ -1,13 +1,28 @@
 import { ReactNode } from 'react';
 type UseThemePropsWithDefaultTheme = {
+    /**
+     * Объект с указанием соответсвия темы и css-класса
+     */
     themeMap: Record<string, string>;
+    /**
+     * Значение темы по умолчанию
+     */
     defaultTheme: string;
 };
 type UseThemeProps = {
+    /**
+     * Объект с указанием соответсвия темы и css-класса
+     */
     themeMap: Record<string, string>;
 };
 export type ThemeProviderProps = {
+    /**
+     * Дети, которые будут обёрнуты в провайдер
+     */
     children: ReactNode;
 } & (UseThemePropsWithDefaultTheme | UseThemeProps);
+/**
+ * Провайдер, предназначенный для работы с темами
+ */
 export declare function ThemeProvider({ children, ...props }: ThemeProviderProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/esm/components/ThemeProvider/ThemeProvider.js

@@ -12,6 +12,9 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { jsx as _jsx } from "react/jsx-runtime";
 import { useThemeConfig } from '../../hooks';
 import { ThemeContext } from './contexts';
+/**
+ * Провайдер, предназначенный для работы с темами
+ */
 export function ThemeProvider(_a) {
     var { children } = _a, props = __rest(_a, ["children"]);
     const themeConfig = useThemeConfig(props);

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

@@ -1,6 +1,6 @@
 export * from './useDebounce';
 export * from './useEventHandler';
 export * from './useIsomorphicLayoutEffect';
-export * from './useSwipe';
+export * from './useSwipeable';
 export * from './useThemeConfig';
 export * from './useValueControl';

package/dist/esm/hooks/index.js

@@ -1,6 +1,6 @@
 export * from './useDebounce';
 export * from './useEventHandler';
 export * from './useIsomorphicLayoutEffect';
-export * from './useSwipe';
+export * from './useSwipeable';
 export * from './useThemeConfig';
 export * from './useValueControl';

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

@@ -1 +1,6 @@
+/**
+ * Хук задерживает выполнение функции или обновление значения до тех пор,
+ * пока не пройдет определенный период времени без новых вызовов.
+ * @function React hook
+ */
 export declare function useDebounce(callback: () => void, timeout?: number): () => void;

package/dist/esm/hooks/useDebounce.js

@@ -1,6 +1,11 @@
 import { useRef } from 'react';
 import { isBrowser } from '../utils';
 import { useEventHandler } from './useEventHandler';
+/**
+ * Хук задерживает выполнение функции или обновление значения до тех пор,
+ * пока не пройдет определенный период времени без новых вызовов.
+ * @function React hook
+ */
 export function useDebounce(callback, timeout = 0) {
     const timeStampRef = useRef(0);
     let timerId = -1;

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

@@ -1 +1,6 @@
+/**
+ * Хук для создания обработчика событий с неизменной функцией.
+ * @function React hook
+ * @param handler коллбек события, без параметров
+ */
 export declare function useEventHandler<T extends (...args: never[]) => unknown>(handler: T): T;

package/dist/esm/hooks/useEventHandler.js

@@ -1,5 +1,10 @@
 import { useCallback, useRef } from 'react';
 import { useLayoutEffect } from './useIsomorphicLayoutEffect';
+/**
+ * Хук для создания обработчика событий с неизменной функцией.
+ * @function React hook
+ * @param handler коллбек события, без параметров
+ */
 export function useEventHandler(handler) {
     const handlerRef = useRef(null);
     useLayoutEffect(() => {

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

@@ -1,2 +1,7 @@
 import { useLayoutEffect as useLayoutEffectInternal } from 'react';
+/**
+ * Хук используется вместо стандартного useLayoutEffect-а,
+ * нужен для корректной работы SSR
+ * @function React hook
+ */
 export declare const useLayoutEffect: typeof useLayoutEffectInternal;

package/dist/esm/hooks/useIsomorphicLayoutEffect.js

@@ -1,4 +1,9 @@
 // eslint-disable-next-line no-restricted-imports
 import { useEffect, useLayoutEffect as useLayoutEffectInternal } from 'react';
 import { isBrowser } from '../utils';
+/**
+ * Хук используется вместо стандартного useLayoutEffect-а,
+ * нужен для корректной работы SSR
+ * @function React hook
+ */
 export const useLayoutEffect = isBrowser() ? useLayoutEffectInternal : useEffect;

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

@@ -0,0 +1,21 @@
+import { SwipeableHandlers, SwipeableProps, SwipeCallback, SwipeDirections, SwipeEventData } from 'react-swipeable';
+export declare const DATA_SWIPE_DIRECTIONS_ATTRIBUTE = "data-swipe-directions";
+export type UseSwipeProps = {
+    /**
+     * Включен ли свайп
+     */
+    enabled?: boolean;
+    /**
+     * Направления, в которых будет работать свайп.
+     * Укажите это свойство, чтобы предотвратить конфликты и заблокировать свайп в родительских элементах по этим направлениям.
+     */
+    availableDirections?: SwipeDirections[];
+} & SwipeableProps;
+export type UseSwipeReturnType = SwipeableHandlers & {
+    [DATA_SWIPE_DIRECTIONS_ATTRIBUTE]?: string;
+};
+/**
+ * Хук для работы с событиями свайпа
+ */
+export declare function useSwipeable({ availableDirections, enabled, ...options }: UseSwipeProps): UseSwipeReturnType;
+export type { SwipeCallback, SwipeDirections, SwipeEventData };

package/dist/esm/hooks/useSwipeable.js

@@ -0,0 +1,61 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { useRef } from 'react';
+import { useSwipeable as useSwipeableInternal, } from 'react-swipeable';
+export const DATA_SWIPE_DIRECTIONS_ATTRIBUTE = 'data-swipe-directions';
+/**
+ * Хук для работы с событиями свайпа
+ */
+export function useSwipeable(_a) {
+    var { availableDirections, enabled = true } = _a, options = __rest(_a, ["availableDirections", "enabled"]);
+    const canSwipe = useRef(true);
+    const onSwipeStart = eventData => {
+        var _a;
+        if (availableDirections) {
+            if (!availableDirections.includes(eventData.dir)) {
+                canSwipe.current = false;
+                return;
+            }
+            if (!options.onSwipeStart) {
+                return;
+            }
+            eventData.event.preventDefault();
+            eventData.event.stopPropagation();
+        }
+        (_a = options.onSwipeStart) === null || _a === void 0 ? void 0 : _a.call(options, eventData);
+    };
+    const onSwiping = eventData => {
+        var _a;
+        if (availableDirections) {
+            if (!canSwipe.current) {
+                return;
+            }
+            eventData.event.preventDefault();
+            eventData.event.stopPropagation();
+        }
+        (_a = options.onSwiping) === null || _a === void 0 ? void 0 : _a.call(options, eventData);
+    };
+    const onSwiped = eventData => {
+        var _a;
+        if (availableDirections) {
+            if (!canSwipe.current) {
+                canSwipe.current = true;
+                return;
+            }
+            eventData.event.preventDefault();
+            eventData.event.stopPropagation();
+        }
+        (_a = options.onSwiped) === null || _a === void 0 ? void 0 : _a.call(options, eventData);
+    };
+    const handlers = useSwipeableInternal(enabled ? Object.assign(Object.assign({}, options), { onSwipeStart, onSwiping, onSwiped }) : {});
+    return Object.assign(Object.assign({}, handlers), { [DATA_SWIPE_DIRECTIONS_ATTRIBUTE]: enabled && availableDirections ? availableDirections.join(' ') : undefined });
+}

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

@@ -3,8 +3,14 @@ type UseThemePropsWithDefaultTheme<T extends string> = {
     defaultTheme: T;
 };
 type UseThemeProps<T extends string> = {
+    /**
+     * Объект с указанием соответсвия темы и css-класса
+     */
     themeMap: Record<T, string>;
 };
+/**
+ * Хук для работы с темами
+ */
 export declare function useThemeConfig<T extends string>(props: UseThemeProps<T>): {
     theme: T | undefined;
     themeClassName: string | undefined;

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

@@ -1,7 +1,20 @@
 type UseValueControl<TValue> = {
+    /**
+     * Значение состояния
+     */
     value?: TValue;
-    onChange?(value: TValue): void;
+    /**
+     * Значение по умолчанию
+     */
     defaultValue?: TValue;
+    /**
+     * Колбек, вызываемый на смену состояния
+     */
+    onChange?(value: TValue): void;
 };
+/**
+ * Хук для работы с состоянием.
+ * Нужен для поддержки controlled/uncontrolled поведения, в зависимости от того были ли переданы входные аргументы
+ */
 export declare function useValueControl<TValue>({ value, onChange, defaultValue }: UseValueControl<TValue>): readonly [TValue | undefined, (value: any, ...args: any[]) => ReturnType<import("uncontrollable").Handler> | void];
 export {};

package/dist/esm/hooks/useValueControl.js

@@ -1,4 +1,8 @@
 import { useUncontrolledProp } from 'uncontrollable';
+/**
+ * Хук для работы с состоянием.
+ * Нужен для поддержки controlled/uncontrolled поведения, в зависимости от того были ли переданы входные аргументы
+ */
 export function useValueControl({ value, onChange, defaultValue }) {
     return useUncontrolledProp(value, defaultValue, (newValue) => {
         const newState = typeof newValue === 'function' ? newValue(value) : newValue;

package/dist/esm/index.d.ts

@@ -1,4 +1,4 @@
 export * from './hooks';
-export * from './utils';
 export * from './components';
+export * from './utils';
 export * from './types';

package/dist/esm/index.js

@@ -1,4 +1,4 @@
 export * from './hooks';
-export * from './utils';
 export * from './components';
+export * from './utils';
 export * from './types';

package/dist/esm/types/index.d.ts

@@ -1 +1,5 @@
+/**
+ * Utility-тип, преобразующий константные значения объекта в union
+ * @function type
+ */
 export type ValueOf<T> = T[keyof T];

package/dist/esm/utils/componentPropsProcessors.d.ts

@@ -2,6 +2,18 @@ import { AriaAttributes } from 'react';
 export type WithSupportProps<T> = {
     'data-test-id'?: string;
 } & AriaAttributes & T;
+/**
+ * Функция для исключения вспомогательных свойств (data-test-id & aria-*)
+ * @function helper
+ */
 export declare function excludeSupportProps<T extends Record<string, unknown>>(props: T): {};
+/**
+ * Функция для отбора свойства data-test-id
+ * @function helper
+ */
 export declare function extractDataTestProps<T extends Record<string, unknown>>(props: T): Record<string, unknown>;
+/**
+ * Функция для отбора вспомогательных свойств (data-test-id & aria-*)
+ * @function helper
+ */
 export declare function extractSupportProps<T extends Record<string, unknown>>(props: T): Record<string, unknown>;

package/dist/esm/utils/componentPropsProcessors.js

@@ -12,12 +12,24 @@ function extractProps(props, regex) {
         return nextProps;
     }, {});
 }
+/**
+ * Функция для исключения вспомогательных свойств (data-test-id & aria-*)
+ * @function helper
+ */
 export function excludeSupportProps(props) {
     return excludeProps(props, DATA_AND_ARIA_REGEXP);
 }
+/**
+ * Функция для отбора свойства data-test-id
+ * @function helper
+ */
 export function extractDataTestProps(props) {
     return extractProps(props, DATA_TEST_REGEXP);
 }
+/**
+ * Функция для отбора вспомогательных свойств (data-test-id & aria-*)
+ * @function helper
+ */
 export function extractSupportProps(props) {
     return extractProps(props, DATA_AND_ARIA_REGEXP);
 }

package/dist/esm/utils/isBrowser.d.ts

@@ -1 +1,6 @@
+/**
+ * Функция проверки текущей среды выполнения кода,
+ * нужна для корректной работы SSR
+ * @function helper
+ */
 export declare function isBrowser(): boolean;

package/dist/esm/utils/isBrowser.js

@@ -1,3 +1,8 @@
+/**
+ * Функция проверки текущей среды выполнения кода,
+ * нужна для корректной работы SSR
+ * @function helper
+ */
 export function isBrowser() {
     // eslint-disable-next-line @cloud-ru/ssr-safe-react/domApi
     return Boolean(typeof window !== 'undefined' && window.document && window.document.createElement);

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "title": "Utils",
-  "version": "3.5.1-preview-53bd8747.0",
+  "version": "3.5.1-preview-baf754b1.0",
   "sideEffects": [
     "*.css",
     "*.woff",
@@ -39,5 +39,5 @@
     "react-swipeable": "7.0.2",
     "uncontrollable": "8.0.4"
   },
-  "gitHead": "527ea8e5660cbf949a1e84bc833f876a0802d10e"
+  "gitHead": "46fb98c10336c2f3dfb35c66737eca5cd3dc6e4f"
 }

package/src/components/ThemeProvider/ThemeProvider.tsx

@@ -3,11 +3,34 @@ import { ReactNode } from 'react';
 import { useThemeConfig } from '../../hooks';
 import { ThemeContext } from './contexts';
 
-type UseThemePropsWithDefaultTheme = { themeMap: Record<string, string>; defaultTheme: string };
-type UseThemeProps = { themeMap: Record<string, string> };
+type UseThemePropsWithDefaultTheme = {
+  /**
+   * Объект с указанием соответсвия темы и css-класса
+   */
+  themeMap: Record<string, string>;
+  /**
+   * Значение темы по умолчанию
+   */
+  defaultTheme: string;
+};
 
-export type ThemeProviderProps = { children: ReactNode } & (UseThemePropsWithDefaultTheme | UseThemeProps);
+type UseThemeProps = {
+  /**
+   * Объект с указанием соответсвия темы и css-класса
+   */
+  themeMap: Record<string, string>;
+};
 
+export type ThemeProviderProps = {
+  /**
+   * Дети, которые будут обёрнуты в провайдер
+   */
+  children: ReactNode;
+} & (UseThemePropsWithDefaultTheme | UseThemeProps);
+
+/**
+ * Провайдер, предназначенный для работы с темами
+ */
 export function ThemeProvider({ children, ...props }: ThemeProviderProps) {
   const themeConfig = useThemeConfig(props);
 

package/src/hooks/index.ts

@@ -1,6 +1,6 @@
 export * from './useDebounce';
 export * from './useEventHandler';
 export * from './useIsomorphicLayoutEffect';
-export * from './useSwipe';
+export * from './useSwipeable';
 export * from './useThemeConfig';
 export * from './useValueControl';

package/src/hooks/useDebounce.ts

@@ -3,6 +3,11 @@ import { useRef } from 'react';
 import { isBrowser } from '../utils';
 import { useEventHandler } from './useEventHandler';
 
+/**
+ * Хук задерживает выполнение функции или обновление значения до тех пор,
+ * пока не пройдет определенный период времени без новых вызовов.
+ * @function React hook
+ */
 export function useDebounce(callback: () => void, timeout = 0) {
   const timeStampRef = useRef<number>(0);
   let timerId: NodeJS.Timeout | number = -1;

package/src/hooks/useEventHandler.ts

@@ -2,6 +2,11 @@ import { useCallback, useRef } from 'react';
 
 import { useLayoutEffect } from './useIsomorphicLayoutEffect';
 
+/**
+ * Хук для создания обработчика событий с неизменной функцией.
+ * @function React hook
+ * @param handler коллбек события, без параметров
+ */
 export function useEventHandler<T extends (...args: never[]) => unknown>(handler: T) {
   const handlerRef = useRef<T | null>(null);
 

package/src/hooks/useIsomorphicLayoutEffect.ts

@@ -3,4 +3,9 @@ import { useEffect, useLayoutEffect as useLayoutEffectInternal } from 'react';
 
 import { isBrowser } from '../utils';
 
+/**
+ * Хук используется вместо стандартного useLayoutEffect-а,
+ * нужен для корректной работы SSR
+ * @function React hook
+ */
 export const useLayoutEffect = isBrowser() ? useLayoutEffectInternal : useEffect;

package/src/hooks/useSwipeable.ts

@@ -0,0 +1,88 @@
+import { useRef } from 'react';
+import {
+  SwipeableHandlers,
+  SwipeableProps,
+  SwipeCallback,
+  SwipeDirections,
+  SwipeEventData,
+  useSwipeable as useSwipeableInternal,
+} from 'react-swipeable';
+
+export const DATA_SWIPE_DIRECTIONS_ATTRIBUTE = 'data-swipe-directions';
+
+export type UseSwipeProps = {
+  /**
+   * Включен ли свайп
+   */
+  enabled?: boolean;
+  /**
+   * Направления, в которых будет работать свайп.
+   * Укажите это свойство, чтобы предотвратить конфликты и заблокировать свайп в родительских элементах по этим направлениям.
+   */
+  availableDirections?: SwipeDirections[];
+} & SwipeableProps;
+
+export type UseSwipeReturnType = SwipeableHandlers & {
+  [DATA_SWIPE_DIRECTIONS_ATTRIBUTE]?: string;
+};
+
+/**
+ * Хук для работы с событиями свайпа
+ */
+export function useSwipeable({ availableDirections, enabled = true, ...options }: UseSwipeProps): UseSwipeReturnType {
+  const canSwipe = useRef(true);
+
+  const onSwipeStart: SwipeCallback = eventData => {
+    if (availableDirections) {
+      if (!availableDirections.includes(eventData.dir)) {
+        canSwipe.current = false;
+        return;
+      }
+
+      if (!options.onSwipeStart) {
+        return;
+      }
+
+      eventData.event.preventDefault();
+      eventData.event.stopPropagation();
+    }
+
+    options.onSwipeStart?.(eventData);
+  };
+
+  const onSwiping: SwipeCallback = eventData => {
+    if (availableDirections) {
+      if (!canSwipe.current) {
+        return;
+      }
+
+      eventData.event.preventDefault();
+      eventData.event.stopPropagation();
+    }
+
+    options.onSwiping?.(eventData);
+  };
+
+  const onSwiped: SwipeCallback = eventData => {
+    if (availableDirections) {
+      if (!canSwipe.current) {
+        canSwipe.current = true;
+        return;
+      }
+
+      eventData.event.preventDefault();
+      eventData.event.stopPropagation();
+    }
+
+    options.onSwiped?.(eventData);
+  };
+
+  const handlers = useSwipeableInternal(enabled ? { ...options, onSwipeStart, onSwiping, onSwiped } : {});
+
+  return {
+    ...handlers,
+    [DATA_SWIPE_DIRECTIONS_ATTRIBUTE]: enabled && availableDirections ? availableDirections.join(' ') : undefined,
+  };
+}
+
+export type { SwipeCallback, SwipeDirections, SwipeEventData };

package/src/hooks/useThemeConfig.tsx

@@ -1,7 +1,12 @@
 import { useState } from 'react';
 
 type UseThemePropsWithDefaultTheme<T extends string> = { themeMap: Record<T, string>; defaultTheme: T };
-type UseThemeProps<T extends string> = { themeMap: Record<T, string> };
+type UseThemeProps<T extends string> = {
+  /**
+   * Объект с указанием соответсвия темы и css-класса
+   */
+  themeMap: Record<T, string>;
+};
 
 function hasDefaultTheme<T extends string>(
   props: UseThemePropsWithDefaultTheme<T> | UseThemeProps<T>,
@@ -9,6 +14,9 @@ function hasDefaultTheme<T extends string>(
   return Boolean((props as UseThemePropsWithDefaultTheme<T>).defaultTheme);
 }
 
+/**
+ * Хук для работы с темами
+ */
 export function useThemeConfig<T extends string>(
   props: UseThemeProps<T>,
 ): {

package/src/hooks/useValueControl.ts

@@ -1,11 +1,24 @@
 import { useUncontrolledProp } from 'uncontrollable';
 
 type UseValueControl<TValue> = {
+  /**
+   * Значение состояния
+   */
   value?: TValue;
-  onChange?(value: TValue): void;
+  /**
+   * Значение по умолчанию
+   */
   defaultValue?: TValue;
+  /**
+   * Колбек, вызываемый на смену состояния
+   */
+  onChange?(value: TValue): void;
 };
 
+/**
+ * Хук для работы с состоянием.
+ * Нужен для поддержки controlled/uncontrolled поведения, в зависимости от того были ли переданы входные аргументы
+ */
 export function useValueControl<TValue>({ value, onChange, defaultValue }: UseValueControl<TValue>) {
   return useUncontrolledProp<TValue>(value, defaultValue, (newValue: TValue) => {
     const newState = typeof newValue === 'function' ? newValue(value) : newValue;

package/src/index.ts

@@ -1,4 +1,4 @@
 export * from './hooks';
-export * from './utils';
 export * from './components';
+export * from './utils';
 export * from './types';

package/src/types/index.ts

@@ -1 +1,5 @@
+/**
+ * Utility-тип, преобразующий константные значения объекта в union
+ * @function type
+ */
 export type ValueOf<T> = T[keyof T];

package/src/utils/componentPropsProcessors.ts

@@ -16,11 +16,14 @@ function excludeProps<T extends Record<string, unknown>>(props: T, regexp: RegEx
 }
 
 function extractProps<T extends Record<string, unknown>>(props: T, regex: RegExp) {
-  return Object.keys(props).reduce((nextProps, prop) => {
-    if (prop.match(regex)) nextProps[prop] = props[prop];
-
-    return nextProps;
-  }, {} as Record<string, unknown>);
+  return Object.keys(props).reduce(
+    (nextProps, prop) => {
+      if (prop.match(regex)) nextProps[prop] = props[prop];
+
+      return nextProps;
+    },
+    {} as Record<string, unknown>,
+  );
 }
 
 export type WithSupportProps<T> = {
@@ -28,14 +31,26 @@ export type WithSupportProps<T> = {
 } & AriaAttributes &
   T;
 
+/**
+ * Функция для исключения вспомогательных свойств (data-test-id & aria-*)
+ * @function helper
+ */
 export function excludeSupportProps<T extends Record<string, unknown>>(props: T) {
   return excludeProps(props, DATA_AND_ARIA_REGEXP);
 }
 
+/**
+ * Функция для отбора свойства data-test-id
+ * @function helper
+ */
 export function extractDataTestProps<T extends Record<string, unknown>>(props: T) {
   return extractProps(props, DATA_TEST_REGEXP);
 }
 
+/**
+ * Функция для отбора вспомогательных свойств (data-test-id & aria-*)
+ * @function helper
+ */
 export function extractSupportProps<T extends Record<string, unknown>>(props: T) {
   return extractProps(props, DATA_AND_ARIA_REGEXP);
 }

package/src/utils/isBrowser.ts

@@ -1,3 +1,8 @@
+/**
+ * Функция проверки текущей среды выполнения кода,
+ * нужна для корректной работы SSR
+ * @function helper
+ */
 export function isBrowser() {
   // eslint-disable-next-line @cloud-ru/ssr-safe-react/domApi
   return Boolean(typeof window !== 'undefined' && window.document && window.document.createElement);

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

@@ -1,8 +0,0 @@
-import { SwipeableHandlers, SwipeableProps, SwipeCallback, SwipeDirections, SwipeEventData } from 'react-swipeable';
-export declare const DATA_SWIPE_ATTRIBUTE = "data-has-swipe";
-export type UseSwipeProps = SwipeableProps;
-export type UseSwipeReturnType = SwipeableHandlers & {
-    [DATA_SWIPE_ATTRIBUTE]: string;
-};
-export declare function useSwipeable(options: UseSwipeProps): UseSwipeReturnType;
-export type { SwipeCallback, SwipeDirections, SwipeEventData };

package/dist/cjs/hooks/useSwipe.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DATA_SWIPE_ATTRIBUTE = void 0;
-exports.useSwipeable = useSwipeable;
-const react_swipeable_1 = require("react-swipeable");
-exports.DATA_SWIPE_ATTRIBUTE = 'data-has-swipe';
-function useSwipeable(options) {
-  const handlers = (0, react_swipeable_1.useSwipeable)(options);
-  return Object.assign(Object.assign({}, handlers), {
-    [exports.DATA_SWIPE_ATTRIBUTE]: 'true'
-  });
-}

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

@@ -1,8 +0,0 @@
-import { SwipeableHandlers, SwipeableProps, SwipeCallback, SwipeDirections, SwipeEventData } from 'react-swipeable';
-export declare const DATA_SWIPE_ATTRIBUTE = "data-has-swipe";
-export type UseSwipeProps = SwipeableProps;
-export type UseSwipeReturnType = SwipeableHandlers & {
-    [DATA_SWIPE_ATTRIBUTE]: string;
-};
-export declare function useSwipeable(options: UseSwipeProps): UseSwipeReturnType;
-export type { SwipeCallback, SwipeDirections, SwipeEventData };

package/dist/esm/hooks/useSwipe.js

@@ -1,6 +0,0 @@
-import { useSwipeable as useSwipeableInternal, } from 'react-swipeable';
-export const DATA_SWIPE_ATTRIBUTE = 'data-has-swipe';
-export function useSwipeable(options) {
-    const handlers = useSwipeableInternal(options);
-    return Object.assign(Object.assign({}, handlers), { [DATA_SWIPE_ATTRIBUTE]: 'true' });
-}

package/src/hooks/useSwipe.ts

@@ -1,27 +0,0 @@
-import {
-  SwipeableHandlers,
-  SwipeableProps,
-  SwipeCallback,
-  SwipeDirections,
-  SwipeEventData,
-  useSwipeable as useSwipeableInternal,
-} from 'react-swipeable';
-
-export const DATA_SWIPE_ATTRIBUTE = 'data-has-swipe';
-
-export type UseSwipeProps = SwipeableProps;
-
-export type UseSwipeReturnType = SwipeableHandlers & {
-  [DATA_SWIPE_ATTRIBUTE]: string;
-};
-
-export function useSwipeable(options: UseSwipeProps): UseSwipeReturnType {
-  const handlers = useSwipeableInternal(options);
-
-  return {
-    ...handlers,
-    [DATA_SWIPE_ATTRIBUTE]: 'true',
-  };
-}
-
-export type { SwipeCallback, SwipeDirections, SwipeEventData };