@snack-uikit/utils 3.10.2-preview-2ce82c96.0 → 4.0.1
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 +20 -0
- package/README.md +40 -4
- package/dist/cjs/hooks/useValueControl.d.ts +1 -1
- package/dist/esm/hooks/useValueControl.d.ts +1 -1
- package/package.json +2 -2
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
|
+
## <small>4.0.1 (2026-01-19)</small>
|
|
7
|
+
|
|
8
|
+
* chore(FF-6693): tune test configs ([d194f4d](https://github.com/cloud-ru-tech/snack-uikit/commit/d194f4d))
|
|
9
|
+
* docs(FF-7788): readme update ([e3142b8](https://github.com/cloud-ru-tech/snack-uikit/commit/e3142b8))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
# 4.0.0 (2025-09-01)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### BREAKING CHANGES
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
* **FF-6982:** rename type, props and returned getter name ([859a025](https://github.com/cloud-ru-tech/snack-uikit/commit/859a025bc670b7882d3286c123d243fc5df0a587))
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
6
26
|
## 3.10.1 (2025-07-16)
|
|
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
|
|
@@ -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[]) =>
|
|
19
|
+
export declare function useValueControl<TValue>({ value, onChange, defaultValue }: UseValueControl<TValue>): readonly [TValue | undefined, (value: any, ...args: any[]) => any];
|
|
20
20
|
export {};
|
|
@@ -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[]) =>
|
|
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": "
|
|
7
|
+
"version": "4.0.1",
|
|
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": "
|
|
42
|
+
"gitHead": "84371bbf91915f650a852df849cd71d416c5b7b2"
|
|
43
43
|
}
|