@astral/ui 2.39.0 → 3.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.
Files changed (2) hide show
  1. package/README.md +61 -0
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -4,6 +4,67 @@
4
4
 
5
5
  # Migration guide
6
6
 
7
+ ## 2.0.0 -> 3.0.0
8
+
9
+ ### ConfigProvider
10
+
11
+ В ConfigProvider добавлен prop ```imagesMap```:
12
+ ```ts
13
+ type ImagesMap = {
14
+ /**
15
+ * @description изображение при отсутствии данных (используется в DataGrid)
16
+ */
17
+ noDataImgSrc: string;
18
+ /**
19
+ * @description изображение при ошибке (используется в ContentState)
20
+ */
21
+ defaultErrorImgSrc: string;
22
+ };
23
+ ```
24
+
25
+ Данный prop содержит ссылки на img, которые используются в компонентах ui-kit.
26
+
27
+ Breaking changes:
28
+ - Компонент DataGrid теперь не инкапсулирует инлайновую svg для отображения NoData статуса. Для того, чтобы изображение появилось необходимо в ConfigProvider указать prop ```imagesMap.noDataImgSrc```
29
+ - Компонент ContentState больше не требует required prop ```errorState.imgSrc```. Ссылка на изображение берется из ConfigProvider
30
+
31
+ ```tsx
32
+ import noDataImgSrc from '@astral/ui/illustrations/no-data.svg';
33
+ import errorImgSrc from 'static/erorr-inmg.png';
34
+
35
+ const App = () => {
36
+ return (
37
+ <ConfigProvider
38
+ imagesMap={{ defaultErrorImgSrc: errorImgSrc, noDataImgSrc }}
39
+ >
40
+ <ThemeProvider>
41
+ <Layout />
42
+ </ThemeProvider>
43
+ </ConfigProvider>
44
+ );
45
+ };
46
+ ```
47
+
48
+ ### Typography
49
+
50
+ Breaking changes:
51
+ - Удалены пропсы, которые являлись css правилами (margin, border, mr...)
52
+ - Prop ```color``` принимает только ```string```. Удалена возможность использовать для color функцию
53
+
54
+ Актуальные props находяться [здесь](https://main--61baeff6f06230003a88ef8a.chromatic.com/?path=/docs/components-typography--showcase).
55
+
56
+ ### Grid
57
+
58
+ Grid из @astral/ui v2 был переименован в LegacyGrid, в четвертой версии @astral/ui данный компонент будет удален.
59
+
60
+ Сигнатуру нового Grid вы можете увидеть в [storybook](https://main--61baeff6f06230003a88ef8a.chromatic.com/?path=/story/components-grid--default).
61
+
62
+ ### Form
63
+
64
+ Breaking changes:
65
+ - Была удалена дефолтная валидация для компонентов: ```FormDatePicker```, ```FormMobilePhoneField```
66
+ - Для филдов формы был удален props ```rules```. Для валидации форм используйте валидацию по схеме с помощью библиотеки [@astral/validations](https://www.npmjs.com/package/@astral/validations)
67
+
7
68
  ## 1.0.0 -> 2.0.0
8
69
 
9
70
  ### Deps
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@astral/ui",
3
- "version": "2.39.0",
3
+ "version": "3.0.1",
4
4
  "browser": "./index.js",
5
5
  "main": "./index.js",
6
6
  "exports": {
@@ -10,9 +10,9 @@
10
10
  "./illustrations/*": "./illustrations/*"
11
11
  },
12
12
  "dependencies": {
13
- "@astral/icons": "^2.39.0",
14
- "@astral/components": "^2.39.0",
15
- "@astral/form": "^2.39.0"
13
+ "@astral/icons": "^3.0.1",
14
+ "@astral/components": "^3.0.1",
15
+ "@astral/form": "^3.0.1"
16
16
  },
17
17
  "peerDependencies": {
18
18
  "react": ">=17.0.0"