@snack-uikit/utils 4.0.0 → 4.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,26 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## 4.0.2 (2026-05-18)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * **PDS-3818:** swap places for useDataPersist so that URL > localStorage ([4018a25](https://github.com/cloud-ru-tech/snack-uikit/commit/4018a2536565b8fb85da1f26b22234806812ef56))
12
+
13
+
14
+
15
+
16
+
17
+ ## <small>4.0.1 (2026-01-19)</small>
18
+
19
+ * chore(FF-6693): tune test configs ([d194f4d](https://github.com/cloud-ru-tech/snack-uikit/commit/d194f4d))
20
+ * docs(FF-7788): readme update ([e3142b8](https://github.com/cloud-ru-tech/snack-uikit/commit/e3142b8))
21
+
22
+
23
+
24
+
25
+
6
26
  # 4.0.0 (2025-09-01)
7
27
 
8
28
 
package/README.md CHANGED
@@ -1,15 +1,51 @@
1
1
  # Utils
2
2
 
3
- ## TODO
4
-
5
- - Increase coverage
6
-
7
3
  ## Installation
8
4
 
9
5
  `npm i @snack-uikit/utils`
10
6
 
11
7
  [Changelog](./CHANGELOG.md)
12
8
 
9
+ ## Description
10
+
11
+ - Пакет `@snack-uikit/utils` предоставляет набор утилит для разработки React-компонентов: React-хуки для работы с состоянием, событиями, темами и другими задачами, а также вспомогательные функции для обработки пропов компонентов и определения окружения выполнения.
12
+ - Хуки поддерживают различные сценарии использования: управление темами (`useThemeConfig`, `ThemeProvider`), работа с контролируемым и неконтролируемым состоянием (`useValueControl`), обработка событий с дебаунсом (`useDebounce`), управление динамическими списками (`useDynamicList`), обработка свайпов (`useSwipeable`), управление состоянием модальных окон (`useModalOpenState`), сохранение данных (`useDataPersist`), а также SSR-совместимые хуки (`useIsomorphicLayoutEffect`, `isBrowser`).
13
+ - Вспомогательные функции помогают работать с пропами компонентов: исключать или извлекать вспомогательные свойства (`excludeSupportProps`, `extractSupportProps`, `extractDataTestProps`) для корректной передачи пропов в DOM-элементы.
14
+ - Хуки оптимизированы для работы в SSR-окружении и поддерживают современные браузерные API (например, `CloseWatcher` для модальных окон).
15
+
16
+ ## Example
17
+
18
+ ```tsx
19
+ import { useThemeConfig } from '@snack-uikit/utils';
20
+
21
+ enum Theme {
22
+ Light = 'Light',
23
+ Dark = 'Dark',
24
+ }
25
+
26
+ const themeMap = {
27
+ [Theme.Light]: 'light-theme-class',
28
+ [Theme.Dark]: 'dark-theme-class',
29
+ };
30
+
31
+ function Example() {
32
+ const theme = useThemeConfig({
33
+ themeMap,
34
+ defaultTheme: Theme.Light
35
+ });
36
+
37
+ return (
38
+ <div className={theme.themeClassName}>
39
+ <button onClick={() => theme.changeTheme(Theme.Dark)}>
40
+ Переключить на тёмную тему
41
+ </button>
42
+ <button onClick={() => theme.changeTheme(Theme.Light)}>
43
+ Переключить на светлую тему
44
+ </button>
45
+ </div>
46
+ );
47
+ }
48
+ ```
13
49
 
14
50
  [//]: DOCUMENTATION_SECTION_START
15
51
  [//]: THIS_SECTION_IS_AUTOGENERATED_PLEASE_DONT_EDIT_IT
@@ -19,13 +19,13 @@ const useDataPersist = _ref => {
19
19
  getData: getLocalStorageData,
20
20
  setData: setLocalStorageData
21
21
  } = (0, useSource_1.useSource)({
22
- source: querySource
22
+ source: localStorageSource
23
23
  });
24
24
  const {
25
25
  getData: getQueryParamsData,
26
26
  setData: setQueryParamsData
27
27
  } = (0, useSource_1.useSource)({
28
- source: localStorageSource
28
+ source: querySource
29
29
  });
30
30
  const setDataToStorages = (0, react_1.useCallback)(data => {
31
31
  setLocalStorageData(data);
@@ -16,5 +16,5 @@ type UseValueControl<TValue> = {
16
16
  * Хук для работы с состоянием.
17
17
  * Нужен для поддержки controlled/uncontrolled поведения, в зависимости от того были ли переданы входные аргументы
18
18
  */
19
- export declare function useValueControl<TValue>({ value, onChange, defaultValue }: UseValueControl<TValue>): readonly [TValue | undefined, (value: any, ...args: any[]) => ReturnType<import("uncontrollable").Handler> | void];
19
+ export declare function useValueControl<TValue>({ value, onChange, defaultValue }: UseValueControl<TValue>): readonly [TValue | undefined, (value: any, ...args: any[]) => any];
20
20
  export {};
@@ -5,10 +5,10 @@ export const useDataPersist = ({ options, parser, serializer }) => {
5
5
  const querySource = useMemo(() => options ? new QueryParamSource(options.queryKey, options.validateData, parser, serializer) : undefined, [options, parser, serializer]);
6
6
  const localStorageSource = useMemo(() => (options ? new LocalStorageSource(options.localStorageKey, options.validateData) : undefined), [options]);
7
7
  const { getData: getLocalStorageData, setData: setLocalStorageData } = useSource({
8
- source: querySource,
8
+ source: localStorageSource,
9
9
  });
10
10
  const { getData: getQueryParamsData, setData: setQueryParamsData } = useSource({
11
- source: localStorageSource,
11
+ source: querySource,
12
12
  });
13
13
  const setDataToStorages = useCallback((data) => {
14
14
  setLocalStorageData(data);
@@ -16,5 +16,5 @@ type UseValueControl<TValue> = {
16
16
  * Хук для работы с состоянием.
17
17
  * Нужен для поддержки controlled/uncontrolled поведения, в зависимости от того были ли переданы входные аргументы
18
18
  */
19
- export declare function useValueControl<TValue>({ value, onChange, defaultValue }: UseValueControl<TValue>): readonly [TValue | undefined, (value: any, ...args: any[]) => ReturnType<import("uncontrollable").Handler> | void];
19
+ export declare function useValueControl<TValue>({ value, onChange, defaultValue }: UseValueControl<TValue>): readonly [TValue | undefined, (value: any, ...args: any[]) => any];
20
20
  export {};
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "access": "public"
5
5
  },
6
6
  "title": "Utils",
7
- "version": "4.0.0",
7
+ "version": "4.0.2",
8
8
  "sideEffects": [
9
9
  "*.css",
10
10
  "*.woff",
@@ -39,5 +39,5 @@
39
39
  "react-swipeable": "7.0.2",
40
40
  "uncontrollable": "8.0.4"
41
41
  },
42
- "gitHead": "881a16cd10831b0effaacb06c506521c8705d9ca"
42
+ "gitHead": "a9f6571146845d828e00206abdedb160980cff97"
43
43
  }
@@ -27,11 +27,11 @@ export const useDataPersist = <TData>({ options, parser, serializer }: DataPersi
27
27
  );
28
28
 
29
29
  const { getData: getLocalStorageData, setData: setLocalStorageData } = useSource<TData>({
30
- source: querySource,
30
+ source: localStorageSource,
31
31
  });
32
32
 
33
33
  const { getData: getQueryParamsData, setData: setQueryParamsData } = useSource<TData>({
34
- source: localStorageSource,
34
+ source: querySource,
35
35
  });
36
36
 
37
37
  const setDataToStorages = useCallback(