@cloud-ru/uikit-product-fields-predefined 0.14.0 → 0.14.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 +11 -0
- package/README.md +236 -0
- package/dist/cjs/components/FieldAi/FieldAi.d.ts +1 -1
- package/dist/cjs/components/FieldDescription/FieldDescription.d.ts +1 -1
- package/dist/cjs/components/FieldDescription/FieldDescriptionRHF.d.ts +1 -1
- package/dist/cjs/components/FieldName/FieldName.d.ts +1 -1
- package/dist/cjs/components/FieldName/FieldNameRHF.d.ts +1 -1
- package/dist/cjs/components/FieldPhone/FieldPhone.d.ts +1 -1
- package/dist/esm/components/FieldAi/FieldAi.d.ts +1 -1
- package/dist/esm/components/FieldDescription/FieldDescription.d.ts +1 -1
- package/dist/esm/components/FieldDescription/FieldDescriptionRHF.d.ts +1 -1
- package/dist/esm/components/FieldName/FieldName.d.ts +1 -1
- package/dist/esm/components/FieldName/FieldNameRHF.d.ts +1 -1
- package/dist/esm/components/FieldPhone/FieldPhone.d.ts +1 -1
- package/dist/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/tsconfig.esm.tsbuildinfo +1 -1
- package/package.json +8 -8
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,17 @@
|
|
|
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
|
+
## 0.14.1 (2025-12-08)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* **UIIAAS-1251:** docs ([0226b84](https://gitverse.ru/cloud-ru-tech/uikit-product/commits/0226b8456be07d407c614979552ce88023eb8bd9))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
6
17
|
# 0.14.0 (2025-12-03)
|
|
7
18
|
|
|
8
19
|
|
package/README.md
CHANGED
|
@@ -14,6 +14,40 @@
|
|
|
14
14
|
### Props
|
|
15
15
|
| name | type | default value | description |
|
|
16
16
|
|------|------|---------------|-------------|
|
|
17
|
+
| layoutType* | enum LayoutType: `"mobile"`, `"tablet"`, `"desktop"`, `"desktopSmall"` | - | |
|
|
18
|
+
| value | `string` | - | Значение input |
|
|
19
|
+
| onChange | `((value: string, e?: ChangeEvent<HTMLInputElement>) => void) & ((value: string) => void)` | - | Колбек смены значения |
|
|
20
|
+
| id | `string` | - | Значение html-атрибута id |
|
|
21
|
+
| name | `string` | - | Значение html-атрибута name |
|
|
22
|
+
| disabled | `boolean` | false | Является ли поле деактивированным |
|
|
23
|
+
| readonly | `boolean` | false | Является ли поле доступным только для чтения |
|
|
24
|
+
| onFocus | `FocusEventHandler<HTMLInputElement>` | - | Колбек обработки получения фокуса |
|
|
25
|
+
| onBlur | `FocusEventHandler<HTMLInputElement>` | - | Колбек обработки потери фокуса |
|
|
26
|
+
| autoComplete | `string \| boolean` | false | Включен ли автокомплит для поля |
|
|
27
|
+
| autoFocus | `boolean` | false | Включен ли авто-фокус для поля |
|
|
28
|
+
| onPaste | `ClipboardEventHandler<HTMLInputElement>` | - | Колбек обработки вставки значения |
|
|
29
|
+
| spellCheck | `boolean` | true | Значение атрибута spellcheck (проверка орфографии) |
|
|
30
|
+
| pattern | `string` | - | Регулярное выражение валидного инпута |
|
|
31
|
+
| className | `string` | - | CSS-класс |
|
|
32
|
+
| label | `string` | - | Лейбл |
|
|
33
|
+
| labelTooltip | `ReactNode` | - | Всплывающая подсказка лейбла |
|
|
34
|
+
| required | `boolean` | - | Является ли поле обязательным |
|
|
35
|
+
| caption | `string` | - | Подпись справа от лейбла |
|
|
36
|
+
| hint | `string` | - | Подсказка внизу |
|
|
37
|
+
| showHintIcon | `boolean` | - | Отображать иконку подсказки |
|
|
38
|
+
| size | enum Size: `"s"`, `"m"`, `"l"` | - | Размер |
|
|
39
|
+
| validationState | enum ValidationState: `"error"`, `"default"`, `"warning"`, `"success"` | - | Состояние валидации |
|
|
40
|
+
| labelTooltipPlacement | enum Placement: `"left"`, `"left-start"`, `"left-end"`, `"right"`, `"right-start"`, `"right-end"`, `"top"`, `"top-start"`, `"top-end"`, `"bottom"`, `"bottom-start"`, `"bottom-end"` | top | Расположение подсказки лейбла |
|
|
41
|
+
| error | `string` | - | |
|
|
42
|
+
| type | "text" \| "tel" \| "email" | - | |
|
|
43
|
+
| showCopyButton | `boolean` | - | Отображение кнопки Копировать для поля (актуально только для `readonly = true`) |
|
|
44
|
+
| onCopyButtonClick | `() => void` | - | Колбек клика по кнопке Копировать для поля |
|
|
45
|
+
| showClearButton | `boolean` | true | Отображение кнопки очистки поля |
|
|
46
|
+
| onClearButtonClick | `() => void` | - | Колбек клика по кнопке очистки поля |
|
|
47
|
+
| scrollList | `boolean` | - | Включить скролл для основной части списка стран |
|
|
48
|
+
| searchPlaceholder | `string` | - | |
|
|
49
|
+
| onChangeCountry | `(country: FieldPhoneOptionsProps) => void` | - | |
|
|
50
|
+
| options | `CountrySettings` | - | options — объект конфигурации для изменения стандартного списка стран |
|
|
17
51
|
| ref | `LegacyRef<HTMLInputElement>` | - | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs} |
|
|
18
52
|
| key | `Key` | - | |
|
|
19
53
|
## useCountries
|
|
@@ -27,25 +61,131 @@
|
|
|
27
61
|
### Props
|
|
28
62
|
| name | type | default value | description |
|
|
29
63
|
|------|------|---------------|-------------|
|
|
64
|
+
| selectProps* | `FieldSelectProps` | - | Пропсы прокидываемые в селект |
|
|
65
|
+
| submitHandler* | `() => Promise<string \| void>` | - | Коллбек создания новой опции, при успешном выполнении возвращает value новой опции |
|
|
66
|
+
| entityName* | `EntityName` | - | Тип объекта для создания новой опции (в единственном числе вин.падеже для кнопки Создать <entityName> и множественном числе) |
|
|
67
|
+
| createLayoutProps* | `CreateLayoutModalProps \| CreateLayoutDrawerProps` | - | Пропсы передаваемые в модалку или дровер создания новой опции |
|
|
68
|
+
| createLayoutType* | "modal" \| "drawer" | - | По клику на кнопку создания открывать модальное окно или дровер |
|
|
69
|
+
| layoutType* | enum LayoutType: `"mobile"`, `"tablet"`, `"desktop"`, `"desktopSmall"` | - | |
|
|
70
|
+
| onRefetch | `VoidFunction` | - | Коллбек рефетча запроса на получение списка опций в случае ошибки (при передаче dataError в selectProps). |
|
|
71
|
+
| className | `string` | - | CSS-класс |
|
|
72
|
+
| afterClose | `VoidFunction` | - | Коллбек после закрытия модального окна/дровера |
|
|
73
|
+
| entityIcon | `JSXElementConstructor<{ size?: number; className?: string; }>` | - | Иконка сервиса |
|
|
74
|
+
| permission | "none" \| "canRead" \| "canCreate" | - | Управление состоянием компонента в зависимости от прав пользователя (по дефолту permission = 'canCreate') |
|
|
30
75
|
## FieldAi
|
|
31
76
|
### Props
|
|
32
77
|
| name | type | default value | description |
|
|
33
78
|
|------|------|---------------|-------------|
|
|
79
|
+
| layoutType* | enum LayoutType: `"mobile"`, `"tablet"`, `"desktop"`, `"desktopSmall"` | - | |
|
|
80
|
+
| onSubmit* | `(value: string) => void` | - | Колбек действия при отправке |
|
|
81
|
+
| value | `string` | - | HTML-аттрибут value |
|
|
82
|
+
| onChange | `(value: string, e?: ChangeEvent<HTMLTextAreaElement>) => void` | - | Колбек смены значения |
|
|
83
|
+
| inputMode | enum InputMode: `"none"`, `"text"`, `"tel"`, `"email"`, `"search"`, `"decimal"`, `"numeric"`, `"url"` | - | Режим работы экранной клавиатуры |
|
|
84
|
+
| id | `string` | - | HTML-аттрибут id |
|
|
85
|
+
| name | `string` | - | HTML-аттрибут name |
|
|
86
|
+
| maxLength | `number` | - | Максимальное кол-во символов |
|
|
87
|
+
| disabled | `boolean` | - | Является ли поле деактивированным |
|
|
88
|
+
| readonly | `boolean` | - | Является ли поле доступным только на чтение |
|
|
89
|
+
| onFocus | `FocusEventHandler<HTMLTextAreaElement>` | - | Колбек получения фокуса |
|
|
90
|
+
| onBlur | `FocusEventHandler<HTMLTextAreaElement>` | - | Колбек потери фокуса |
|
|
91
|
+
| autoFocus | `boolean` | - | Включен ли авто-фокус |
|
|
92
|
+
| onKeyDown | `KeyboardEventHandler<HTMLTextAreaElement>` | - | Колбек нажатия клавиши клавиатуры |
|
|
93
|
+
| className | `string` | - | CSS-класс |
|
|
94
|
+
| caption | `string` | - | Подпись справа от лейбла |
|
|
95
|
+
| hint | `string` | - | Подсказка внизу |
|
|
96
|
+
| showHintIcon | `boolean` | - | Отображать иконку подсказки |
|
|
97
|
+
| validationState | enum ValidationState: `"error"`, `"default"`, `"warning"`, `"success"` | - | Состояние валидации |
|
|
98
|
+
| labelTooltipPlacement | enum Placement: `"left"`, `"left-start"`, `"left-end"`, `"right"`, `"right-start"`, `"right-end"`, `"top"`, `"top-start"`, `"top-end"`, `"bottom"`, `"bottom-start"`, `"bottom-end"` | top | Расположение подсказки лейбла |
|
|
99
|
+
| error | `string` | - | |
|
|
100
|
+
| allowMoreThanMaxLength | `boolean` | - | Можно ли вводить больше разрешённого кол-ва символов |
|
|
101
|
+
| showCopyButton | `boolean` | - | Отображение кнопки Копировать для поля (актуально только для `readonly = true`) |
|
|
102
|
+
| onCopyButtonClick | `() => void` | - | Колбек клика по кнопке Копировать для поля |
|
|
103
|
+
| showClearButton | `boolean` | true | Отображение кнопки очистки поля |
|
|
104
|
+
| minRows | `number` | 3 | Минимальное кол-во строк, до которого размер поля может быть увеличен |
|
|
105
|
+
| maxRows | `number` | 1000 | Максимальное кол-во строк, до которого размер поля может быть увеличен |
|
|
106
|
+
| resizable | `boolean` | - | Может ли ли пользователь изменять размеры поля (если св-во не включено, поле автоматически меняет свой размер) |
|
|
107
|
+
| secure | `boolean \| "password"` | - | Режим ввода sensitive данных (пароля, API ключей, токенов, etc) |
|
|
108
|
+
| onResetContextClick | `() => void` | - | Действие при клике по кнопке сброса контекста |
|
|
34
109
|
| ref | `LegacyRef<HTMLTextAreaElement>` | - | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs} |
|
|
35
110
|
| key | `Key` | - | |
|
|
36
111
|
## FieldChat
|
|
37
112
|
### Props
|
|
38
113
|
| name | type | default value | description |
|
|
39
114
|
|------|------|---------------|-------------|
|
|
115
|
+
| layoutType* | enum LayoutType: `"mobile"`, `"tablet"`, `"desktop"`, `"desktopSmall"` | - | |
|
|
116
|
+
| handleSubmit* | `(value: string) => void` | - | Колбек действия при отправке |
|
|
117
|
+
| value | `string` | - | HTML-аттрибут value |
|
|
118
|
+
| onChange | `(value: string, e?: ChangeEvent<HTMLTextAreaElement>) => void` | - | Колбек смены значения |
|
|
119
|
+
| inputMode | enum InputMode: `"none"`, `"text"`, `"tel"`, `"email"`, `"search"`, `"decimal"`, `"numeric"`, `"url"` | - | Режим работы экранной клавиатуры |
|
|
120
|
+
| id | `string` | - | HTML-аттрибут id |
|
|
121
|
+
| name | `string` | - | HTML-аттрибут name |
|
|
122
|
+
| maxLength | `number` | - | Максимальное кол-во символов |
|
|
123
|
+
| disabled | `boolean` | - | Является ли поле деактивированным |
|
|
124
|
+
| readonly | `boolean` | - | Является ли поле доступным только на чтение |
|
|
125
|
+
| onFocus | `FocusEventHandler<HTMLTextAreaElement>` | - | Колбек получения фокуса |
|
|
126
|
+
| onBlur | `FocusEventHandler<HTMLTextAreaElement>` | - | Колбек потери фокуса |
|
|
127
|
+
| autoFocus | `boolean` | - | Включен ли авто-фокус |
|
|
128
|
+
| onKeyDown | `KeyboardEventHandler<HTMLTextAreaElement>` | - | Колбек нажатия клавиши клавиатуры |
|
|
129
|
+
| className | `string` | - | CSS-класс |
|
|
130
|
+
| caption | `string` | - | Подпись справа от лейбла |
|
|
131
|
+
| showHintIcon | `boolean` | - | Отображать иконку подсказки |
|
|
132
|
+
| validationState | enum ValidationState: `"error"`, `"default"`, `"warning"`, `"success"` | - | Состояние валидации |
|
|
133
|
+
| labelTooltipPlacement | enum Placement: `"left"`, `"left-start"`, `"left-end"`, `"right"`, `"right-start"`, `"right-end"`, `"top"`, `"top-start"`, `"top-end"`, `"bottom"`, `"bottom-start"`, `"bottom-end"` | top | Расположение подсказки лейбла |
|
|
134
|
+
| error | `string` | - | |
|
|
135
|
+
| allowMoreThanMaxLength | `boolean` | - | Можно ли вводить больше разрешённого кол-ва символов |
|
|
136
|
+
| showCopyButton | `boolean` | - | Отображение кнопки Копировать для поля (актуально только для `readonly = true`) |
|
|
137
|
+
| onCopyButtonClick | `() => void` | - | Колбек клика по кнопке Копировать для поля |
|
|
138
|
+
| showClearButton | `boolean` | true | Отображение кнопки очистки поля |
|
|
139
|
+
| minRows | `number` | 3 | Минимальное кол-во строк, до которого размер поля может быть увеличен |
|
|
140
|
+
| maxRows | `number` | 1000 | Максимальное кол-во строк, до которого размер поля может быть увеличен |
|
|
141
|
+
| resizable | `boolean` | - | Может ли ли пользователь изменять размеры поля (если св-во не включено, поле автоматически меняет свой размер) |
|
|
142
|
+
| attachment | `Pick<FileUploadProps, "onFilesUpload" \| "accept"> & { files?: File[]; onFileDelete: (file?: File) => void; }` | - | |
|
|
40
143
|
## AIDisclaimer
|
|
41
144
|
### Props
|
|
42
145
|
| name | type | default value | description |
|
|
43
146
|
|------|------|---------------|-------------|
|
|
147
|
+
| layoutType* | enum LayoutType: `"mobile"`, `"tablet"`, `"desktop"`, `"desktopSmall"` | - | |
|
|
44
148
|
## FieldName
|
|
45
149
|
Поле имя c локальным стейтом и валидацией
|
|
46
150
|
### Props
|
|
47
151
|
| name | type | default value | description |
|
|
48
152
|
|------|------|---------------|-------------|
|
|
153
|
+
| layoutType* | enum LayoutType: `"mobile"`, `"tablet"`, `"desktop"`, `"desktopSmall"` | - | |
|
|
154
|
+
| value | `string` | - | Значение input |
|
|
155
|
+
| onChange | `(value: string, e?: ChangeEvent<HTMLInputElement>) => void` | - | Колбек смены значения |
|
|
156
|
+
| id | `string` | - | Значение html-атрибута id |
|
|
157
|
+
| name | `string` | - | Значение html-атрибута name |
|
|
158
|
+
| maxLength | `number` | - | Максимальная длина вводимого значения |
|
|
159
|
+
| disabled | `boolean` | false | Является ли поле деактивированным |
|
|
160
|
+
| readonly | `boolean` | false | Является ли поле доступным только для чтения |
|
|
161
|
+
| onFocus | `FocusEventHandler<HTMLInputElement>` | - | Колбек обработки получения фокуса |
|
|
162
|
+
| onBlur | `FocusEventHandler<HTMLInputElement>` | - | Колбек обработки потери фокуса |
|
|
163
|
+
| autoComplete | `string \| boolean` | false | Включен ли автокомплит для поля |
|
|
164
|
+
| autoFocus | `boolean` | false | Включен ли авто-фокус для поля |
|
|
165
|
+
| onPaste | `ClipboardEventHandler<HTMLInputElement>` | - | Колбек обработки вставки значения |
|
|
166
|
+
| onKeyDown | `KeyboardEventHandler<HTMLInputElement>` | - | Колбек обработки начала нажатия клавиши клавиатуры |
|
|
167
|
+
| spellCheck | `boolean` | true | Значение атрибута spellcheck (проверка орфографии) |
|
|
168
|
+
| pattern | `string` | - | Регулярное выражение валидного инпута |
|
|
169
|
+
| className | `string` | - | CSS-класс |
|
|
170
|
+
| labelTooltip | `ReactNode` | - | Всплывающая подсказка лейбла |
|
|
171
|
+
| required | `boolean` | - | Является ли поле обязательным |
|
|
172
|
+
| showHintIcon | `boolean` | - | Отображать иконку подсказки |
|
|
173
|
+
| size | enum Size: `"s"`, `"m"`, `"l"` | - | Размер |
|
|
174
|
+
| validationState | enum ValidationState: `"error"`, `"default"`, `"warning"`, `"success"` | - | Состояние валидации |
|
|
175
|
+
| labelTooltipPlacement | enum Placement: `"left"`, `"left-start"`, `"left-end"`, `"right"`, `"right-start"`, `"right-end"`, `"top"`, `"top-start"`, `"top-end"`, `"bottom"`, `"bottom-start"`, `"bottom-end"` | top | Расположение подсказки лейбла |
|
|
176
|
+
| error | `string` | - | |
|
|
177
|
+
| prefix | `ReactNode` | - | Произвольный префикс для поля |
|
|
178
|
+
| prefixIcon | `ReactElement<any, string \| JSXElementConstructor<any>>` | - | Иконка-префикс для поля |
|
|
179
|
+
| postfix | `ReactNode` | - | Произвольный постфикс для поля |
|
|
180
|
+
| allowMoreThanMaxLength | `boolean` | - | Можно ли вводить больше разрешённого кол-ва символов |
|
|
181
|
+
| button | `Button` | - | Кнопка действия внутри поля |
|
|
182
|
+
| showCopyButton | `boolean` | - | Отображение кнопки Копировать для поля (актуально только для `readonly = true`) |
|
|
183
|
+
| onCopyButtonClick | `() => void` | - | Колбек клика по кнопке Копировать для поля |
|
|
184
|
+
| showClearButton | `boolean` | true | Отображение кнопки очистки поля |
|
|
185
|
+
| onClearButtonClick | `() => void` | - | Колбек клика по кнопке очистки поля |
|
|
186
|
+
| showLabel | `boolean` | - | |
|
|
187
|
+
| customSchema | `StringSchema<string, AnyObject, undefined, "">` | - | |
|
|
188
|
+
| onValidationError | `(error: ValidationError) => void` | - | Колбэк, вызываемый при изменении ошибки валидации |
|
|
49
189
|
| ref | `LegacyRef<HTMLInputElement>` | - | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs} |
|
|
50
190
|
| key | `Key` | - | |
|
|
51
191
|
## FieldNameRHF
|
|
@@ -53,6 +193,42 @@
|
|
|
53
193
|
### Props
|
|
54
194
|
| name | type | default value | description |
|
|
55
195
|
|------|------|---------------|-------------|
|
|
196
|
+
| layoutType* | enum LayoutType: `"mobile"`, `"tablet"`, `"desktop"`, `"desktopSmall"` | - | |
|
|
197
|
+
| controllerProps* | `Omit<ControllerProps<FieldValues>, "disabled" \| "render" \| "rules">` | - | Режим контроллера с использованием react-hook-form |
|
|
198
|
+
| value | `string` | - | Значение input |
|
|
199
|
+
| onChange | `(value: string, e?: ChangeEvent<HTMLInputElement>) => void` | - | Колбек смены значения |
|
|
200
|
+
| id | `string` | - | Значение html-атрибута id |
|
|
201
|
+
| name | `string` | - | Значение html-атрибута name |
|
|
202
|
+
| maxLength | `number` | - | Максимальная длина вводимого значения |
|
|
203
|
+
| disabled | `boolean` | false | Является ли поле деактивированным |
|
|
204
|
+
| readonly | `boolean` | false | Является ли поле доступным только для чтения |
|
|
205
|
+
| onFocus | `FocusEventHandler<HTMLInputElement>` | - | Колбек обработки получения фокуса |
|
|
206
|
+
| onBlur | `FocusEventHandler<HTMLInputElement>` | - | Колбек обработки потери фокуса |
|
|
207
|
+
| autoComplete | `string \| boolean` | false | Включен ли автокомплит для поля |
|
|
208
|
+
| autoFocus | `boolean` | false | Включен ли авто-фокус для поля |
|
|
209
|
+
| onPaste | `ClipboardEventHandler<HTMLInputElement>` | - | Колбек обработки вставки значения |
|
|
210
|
+
| onKeyDown | `KeyboardEventHandler<HTMLInputElement>` | - | Колбек обработки начала нажатия клавиши клавиатуры |
|
|
211
|
+
| spellCheck | `boolean` | true | Значение атрибута spellcheck (проверка орфографии) |
|
|
212
|
+
| pattern | `string` | - | Регулярное выражение валидного инпута |
|
|
213
|
+
| className | `string` | - | CSS-класс |
|
|
214
|
+
| labelTooltip | `ReactNode` | - | Всплывающая подсказка лейбла |
|
|
215
|
+
| required | `boolean` | - | Является ли поле обязательным |
|
|
216
|
+
| showHintIcon | `boolean` | - | Отображать иконку подсказки |
|
|
217
|
+
| size | enum Size: `"s"`, `"m"`, `"l"` | - | Размер |
|
|
218
|
+
| validationState | enum ValidationState: `"error"`, `"default"`, `"warning"`, `"success"` | - | Состояние валидации |
|
|
219
|
+
| labelTooltipPlacement | enum Placement: `"left"`, `"left-start"`, `"left-end"`, `"right"`, `"right-start"`, `"right-end"`, `"top"`, `"top-start"`, `"top-end"`, `"bottom"`, `"bottom-start"`, `"bottom-end"` | top | Расположение подсказки лейбла |
|
|
220
|
+
| error | `string` | - | |
|
|
221
|
+
| prefix | `ReactNode` | - | Произвольный префикс для поля |
|
|
222
|
+
| prefixIcon | `ReactElement<any, string \| JSXElementConstructor<any>>` | - | Иконка-префикс для поля |
|
|
223
|
+
| postfix | `ReactNode` | - | Произвольный постфикс для поля |
|
|
224
|
+
| allowMoreThanMaxLength | `boolean` | - | Можно ли вводить больше разрешённого кол-ва символов |
|
|
225
|
+
| button | `Button` | - | Кнопка действия внутри поля |
|
|
226
|
+
| showCopyButton | `boolean` | - | Отображение кнопки Копировать для поля (актуально только для `readonly = true`) |
|
|
227
|
+
| onCopyButtonClick | `() => void` | - | Колбек клика по кнопке Копировать для поля |
|
|
228
|
+
| showClearButton | `boolean` | true | Отображение кнопки очистки поля |
|
|
229
|
+
| onClearButtonClick | `() => void` | - | Колбек клика по кнопке очистки поля |
|
|
230
|
+
| showLabel | `boolean` | - | |
|
|
231
|
+
| customSchema | `StringSchema<string, AnyObject, undefined, "">` | - | |
|
|
56
232
|
| ref | `LegacyRef<HTMLInputElement>` | - | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs} |
|
|
57
233
|
| key | `Key` | - | |
|
|
58
234
|
## FieldDescription
|
|
@@ -60,6 +236,36 @@
|
|
|
60
236
|
### Props
|
|
61
237
|
| name | type | default value | description |
|
|
62
238
|
|------|------|---------------|-------------|
|
|
239
|
+
| layoutType* | enum LayoutType: `"mobile"`, `"tablet"`, `"desktop"`, `"desktopSmall"` | - | |
|
|
240
|
+
| value | `string` | - | HTML-аттрибут value |
|
|
241
|
+
| onChange | `(value: string, e?: ChangeEvent<HTMLTextAreaElement>) => void` | - | Колбек смены значения |
|
|
242
|
+
| id | `string` | - | HTML-аттрибут id |
|
|
243
|
+
| maxLength | `number` | 255 | Максимальное кол-во символов |
|
|
244
|
+
| disabled | `boolean` | - | Является ли поле деактивированным |
|
|
245
|
+
| readonly | `boolean` | - | Является ли поле доступным только на чтение |
|
|
246
|
+
| onFocus | `FocusEventHandler<HTMLTextAreaElement>` | - | Колбек получения фокуса |
|
|
247
|
+
| onBlur | `FocusEventHandler<HTMLTextAreaElement>` | - | Колбек потери фокуса |
|
|
248
|
+
| autoFocus | `boolean` | - | Включен ли авто-фокус |
|
|
249
|
+
| onKeyDown | `KeyboardEventHandler<HTMLTextAreaElement>` | - | Колбек нажатия клавиши клавиатуры |
|
|
250
|
+
| spellCheck | `boolean` | true | Включение проверки орфографии |
|
|
251
|
+
| className | `string` | - | CSS-класс |
|
|
252
|
+
| labelTooltip | `ReactNode` | - | Всплывающая подсказка лейбла |
|
|
253
|
+
| required | `boolean` | - | Является ли поле обязательным |
|
|
254
|
+
| showHintIcon | `boolean` | - | Отображать иконку подсказки |
|
|
255
|
+
| size | enum Size: `"s"`, `"m"`, `"l"` | m | Размер |
|
|
256
|
+
| validationState | enum ValidationState: `"error"`, `"default"`, `"warning"`, `"success"` | - | Состояние валидации |
|
|
257
|
+
| labelTooltipPlacement | enum Placement: `"left"`, `"left-start"`, `"left-end"`, `"right"`, `"right-start"`, `"right-end"`, `"top"`, `"top-start"`, `"top-end"`, `"bottom"`, `"bottom-start"`, `"bottom-end"` | top | Расположение подсказки лейбла |
|
|
258
|
+
| error | `string` | - | |
|
|
259
|
+
| allowMoreThanMaxLength | `boolean` | - | Можно ли вводить больше разрешённого кол-ва символов |
|
|
260
|
+
| showCopyButton | `boolean` | - | Отображение кнопки Копировать для поля (актуально только для `readonly = true`) |
|
|
261
|
+
| onCopyButtonClick | `() => void` | - | Колбек клика по кнопке Копировать для поля |
|
|
262
|
+
| showClearButton | `boolean` | true | Отображение кнопки очистки поля |
|
|
263
|
+
| minRows | `number` | 3 | Минимальное кол-во строк, до которого размер поля может быть увеличен |
|
|
264
|
+
| maxRows | `number` | 1000 | Максимальное кол-во строк, до которого размер поля может быть увеличен |
|
|
265
|
+
| resizable | `boolean` | true | Может ли ли пользователь изменять размеры поля (если св-во не включено, поле автоматически меняет свой размер) |
|
|
266
|
+
| customSchema | `StringSchema<string, AnyObject, undefined, "">` | - | |
|
|
267
|
+
| addButton | `boolean` | - | Поле появляется по кнопке "Добавить описание" (только для опционального поля) |
|
|
268
|
+
| onValidationError | `(error: ValidationError) => void` | - | Колбэк, вызываемый при изменении ошибки валидации (только в standalone режиме) |
|
|
63
269
|
| ref | `LegacyRef<HTMLTextAreaElement>` | - | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs} |
|
|
64
270
|
| key | `Key` | - | |
|
|
65
271
|
## FieldDescriptionRHF
|
|
@@ -67,6 +273,36 @@
|
|
|
67
273
|
### Props
|
|
68
274
|
| name | type | default value | description |
|
|
69
275
|
|------|------|---------------|-------------|
|
|
276
|
+
| layoutType* | enum LayoutType: `"mobile"`, `"tablet"`, `"desktop"`, `"desktopSmall"` | - | |
|
|
277
|
+
| controllerProps* | `Omit<ControllerProps<FieldValues>, "disabled" \| "render" \| "rules">` | - | Режим контроллера с использованием react-hook-form |
|
|
278
|
+
| value | `string` | - | HTML-аттрибут value |
|
|
279
|
+
| onChange | `(value: string, e?: ChangeEvent<HTMLTextAreaElement>) => void` | - | Колбек смены значения |
|
|
280
|
+
| id | `string` | - | HTML-аттрибут id |
|
|
281
|
+
| maxLength | `number` | 255 | Максимальное кол-во символов |
|
|
282
|
+
| disabled | `boolean` | - | Является ли поле деактивированным |
|
|
283
|
+
| readonly | `boolean` | - | Является ли поле доступным только на чтение |
|
|
284
|
+
| onFocus | `FocusEventHandler<HTMLTextAreaElement>` | - | Колбек получения фокуса |
|
|
285
|
+
| onBlur | `FocusEventHandler<HTMLTextAreaElement>` | - | Колбек потери фокуса |
|
|
286
|
+
| autoFocus | `boolean` | - | Включен ли авто-фокус |
|
|
287
|
+
| onKeyDown | `KeyboardEventHandler<HTMLTextAreaElement>` | - | Колбек нажатия клавиши клавиатуры |
|
|
288
|
+
| spellCheck | `boolean` | true | Включение проверки орфографии |
|
|
289
|
+
| className | `string` | - | CSS-класс |
|
|
290
|
+
| labelTooltip | `ReactNode` | - | Всплывающая подсказка лейбла |
|
|
291
|
+
| required | `boolean` | - | Является ли поле обязательным |
|
|
292
|
+
| showHintIcon | `boolean` | - | Отображать иконку подсказки |
|
|
293
|
+
| size | enum Size: `"s"`, `"m"`, `"l"` | m | Размер |
|
|
294
|
+
| validationState | enum ValidationState: `"error"`, `"default"`, `"warning"`, `"success"` | - | Состояние валидации |
|
|
295
|
+
| labelTooltipPlacement | enum Placement: `"left"`, `"left-start"`, `"left-end"`, `"right"`, `"right-start"`, `"right-end"`, `"top"`, `"top-start"`, `"top-end"`, `"bottom"`, `"bottom-start"`, `"bottom-end"` | top | Расположение подсказки лейбла |
|
|
296
|
+
| error | `string` | - | |
|
|
297
|
+
| allowMoreThanMaxLength | `boolean` | - | Можно ли вводить больше разрешённого кол-ва символов |
|
|
298
|
+
| showCopyButton | `boolean` | - | Отображение кнопки Копировать для поля (актуально только для `readonly = true`) |
|
|
299
|
+
| onCopyButtonClick | `() => void` | - | Колбек клика по кнопке Копировать для поля |
|
|
300
|
+
| showClearButton | `boolean` | true | Отображение кнопки очистки поля |
|
|
301
|
+
| minRows | `number` | 3 | Минимальное кол-во строк, до которого размер поля может быть увеличен |
|
|
302
|
+
| maxRows | `number` | 1000 | Максимальное кол-во строк, до которого размер поля может быть увеличен |
|
|
303
|
+
| resizable | `boolean` | true | Может ли ли пользователь изменять размеры поля (если св-во не включено, поле автоматически меняет свой размер) |
|
|
304
|
+
| customSchema | `StringSchema<string, AnyObject, undefined, "">` | - | |
|
|
305
|
+
| addButton | `boolean` | - | Поле появляется по кнопке "Добавить описание" (только для опционального поля) |
|
|
70
306
|
| ref | `LegacyRef<HTMLTextAreaElement>` | - | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs} |
|
|
71
307
|
| key | `Key` | - | |
|
|
72
308
|
|
|
@@ -16,5 +16,5 @@ export declare const FieldAi: import("react").ForwardRefExoticComponent<Omit<Fie
|
|
|
16
16
|
/** Действие при клике по кнопке сброса контекста */
|
|
17
17
|
onResetContextClick?(): void;
|
|
18
18
|
} & {
|
|
19
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
19
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
20
20
|
} & import("react").RefAttributes<HTMLTextAreaElement>>;
|
|
@@ -8,5 +8,5 @@ export declare const FieldDescription: import("react").ForwardRefExoticComponent
|
|
|
8
8
|
} & {
|
|
9
9
|
onValidationError?: (error: ValidationError | null) => void;
|
|
10
10
|
} & {
|
|
11
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
11
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
12
12
|
} & import("react").RefAttributes<HTMLTextAreaElement>>;
|
|
@@ -7,5 +7,5 @@ export declare const FieldDescriptionRHF: import("react").ForwardRefExoticCompon
|
|
|
7
7
|
} & {
|
|
8
8
|
controllerProps: Omit<import("react-hook-form").ControllerProps<import("react-hook-form").FieldValues>, "render" | "rules" | "disabled">;
|
|
9
9
|
} & {
|
|
10
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
10
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
11
11
|
} & import("react").RefAttributes<HTMLTextAreaElement>>;
|
|
@@ -8,5 +8,5 @@ export declare const FieldName: import("react").ForwardRefExoticComponent<Omit<i
|
|
|
8
8
|
} & {
|
|
9
9
|
onValidationError?: (error: ValidationError | null) => void;
|
|
10
10
|
} & {
|
|
11
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
11
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
12
12
|
} & import("react").RefAttributes<HTMLInputElement>>;
|
|
@@ -7,5 +7,5 @@ export declare const FieldNameRHF: import("react").ForwardRefExoticComponent<Omi
|
|
|
7
7
|
} & {
|
|
8
8
|
controllerProps: Omit<import("react-hook-form").ControllerProps<import("react-hook-form").FieldValues>, "render" | "rules" | "disabled">;
|
|
9
9
|
} & {
|
|
10
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
10
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
11
11
|
} & import("react").RefAttributes<HTMLInputElement>>;
|
|
@@ -21,5 +21,5 @@ export declare const FieldPhone: import("react").ForwardRefExoticComponent<Omit<
|
|
|
21
21
|
/** options — объект конфигурации для изменения стандартного списка стран */
|
|
22
22
|
options?: CountrySettings;
|
|
23
23
|
} & {
|
|
24
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
24
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
25
25
|
} & import("react").RefAttributes<HTMLInputElement>>;
|
|
@@ -16,5 +16,5 @@ export declare const FieldAi: import("react").ForwardRefExoticComponent<Omit<Fie
|
|
|
16
16
|
/** Действие при клике по кнопке сброса контекста */
|
|
17
17
|
onResetContextClick?(): void;
|
|
18
18
|
} & {
|
|
19
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
19
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
20
20
|
} & import("react").RefAttributes<HTMLTextAreaElement>>;
|
|
@@ -8,5 +8,5 @@ export declare const FieldDescription: import("react").ForwardRefExoticComponent
|
|
|
8
8
|
} & {
|
|
9
9
|
onValidationError?: (error: ValidationError | null) => void;
|
|
10
10
|
} & {
|
|
11
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
11
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
12
12
|
} & import("react").RefAttributes<HTMLTextAreaElement>>;
|
|
@@ -7,5 +7,5 @@ export declare const FieldDescriptionRHF: import("react").ForwardRefExoticCompon
|
|
|
7
7
|
} & {
|
|
8
8
|
controllerProps: Omit<import("react-hook-form").ControllerProps<import("react-hook-form").FieldValues>, "render" | "rules" | "disabled">;
|
|
9
9
|
} & {
|
|
10
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
10
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
11
11
|
} & import("react").RefAttributes<HTMLTextAreaElement>>;
|
|
@@ -8,5 +8,5 @@ export declare const FieldName: import("react").ForwardRefExoticComponent<Omit<i
|
|
|
8
8
|
} & {
|
|
9
9
|
onValidationError?: (error: ValidationError | null) => void;
|
|
10
10
|
} & {
|
|
11
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
11
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
12
12
|
} & import("react").RefAttributes<HTMLInputElement>>;
|
|
@@ -7,5 +7,5 @@ export declare const FieldNameRHF: import("react").ForwardRefExoticComponent<Omi
|
|
|
7
7
|
} & {
|
|
8
8
|
controllerProps: Omit<import("react-hook-form").ControllerProps<import("react-hook-form").FieldValues>, "render" | "rules" | "disabled">;
|
|
9
9
|
} & {
|
|
10
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
10
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
11
11
|
} & import("react").RefAttributes<HTMLInputElement>>;
|
|
@@ -21,5 +21,5 @@ export declare const FieldPhone: import("react").ForwardRefExoticComponent<Omit<
|
|
|
21
21
|
/** options — объект конфигурации для изменения стандартного списка стран */
|
|
22
22
|
options?: CountrySettings;
|
|
23
23
|
} & {
|
|
24
|
-
layoutType: import("@cloud-ru/uikit-product-utils
|
|
24
|
+
layoutType: import("@cloud-ru/uikit-product-utils").LayoutType;
|
|
25
25
|
} & import("react").RefAttributes<HTMLInputElement>>;
|