@steroidsjs/core 3.0.92 → 3.0.93

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.
@@ -3555,6 +3555,14 @@
3555
3555
  "type": "string | number",
3556
3556
  "example": null
3557
3557
  },
3558
+ {
3559
+ "name": "isCritical",
3560
+ "decorators": [],
3561
+ "description": "Применяется для ssr. Если fetch критический — ssr вернет страницу со статус кодом ошибки.",
3562
+ "required": false,
3563
+ "type": "boolean",
3564
+ "example": null
3565
+ },
3558
3566
  {
3559
3567
  "name": "method",
3560
3568
  "decorators": [],
@@ -5499,6 +5507,17 @@
5499
5507
  "properties": [],
5500
5508
  "methods": []
5501
5509
  },
5510
+ "IPreloadedErrors": {
5511
+ "name": "IPreloadedErrors",
5512
+ "moduleName": "providers/SsrProvider",
5513
+ "title": "",
5514
+ "description": "",
5515
+ "tags": {},
5516
+ "defaultProps": null,
5517
+ "extends": [],
5518
+ "properties": [],
5519
+ "methods": []
5520
+ },
5502
5521
  "ISsr": {
5503
5522
  "name": "ISsr",
5504
5523
  "moduleName": "providers/SsrProvider",
@@ -5524,6 +5543,14 @@
5524
5543
  "type": "IPreloadedData",
5525
5544
  "example": null
5526
5545
  },
5546
+ {
5547
+ "name": "preloadedErrors",
5548
+ "decorators": [],
5549
+ "description": "",
5550
+ "required": false,
5551
+ "type": "IPreloadedErrors",
5552
+ "example": null
5553
+ },
5527
5554
  {
5528
5555
  "name": "staticContext",
5529
5556
  "decorators": [],
@@ -5565,6 +5592,15 @@
5565
5592
  "example": null,
5566
5593
  "defaultValue": null
5567
5594
  },
5595
+ {
5596
+ "name": "preloadedErrors",
5597
+ "decorators": [],
5598
+ "description": "",
5599
+ "required": false,
5600
+ "type": "IPreloadedErrors",
5601
+ "example": null,
5602
+ "defaultValue": null
5603
+ },
5568
5604
  {
5569
5605
  "name": "staticContext",
5570
5606
  "decorators": [],
@@ -27999,55 +28035,17 @@
27999
28035
  }
28000
28036
  ]
28001
28037
  },
28002
- "IRateFieldItem": {
28003
- "name": "IRateFieldItem",
28004
- "moduleName": "ui/form/RateField/RateField",
28005
- "title": "",
28006
- "description": "",
28007
- "tags": {},
28008
- "defaultProps": null,
28009
- "extends": [],
28010
- "properties": [
28011
- {
28012
- "name": "id",
28013
- "decorators": [],
28014
- "description": "",
28015
- "required": true,
28016
- "type": "number",
28017
- "example": null
28018
- },
28019
- {
28020
- "name": "value",
28021
- "decorators": [],
28022
- "description": "",
28023
- "required": true,
28024
- "type": "number",
28025
- "example": null
28026
- }
28027
- ],
28028
- "methods": []
28029
- },
28030
- "IRateFieldProps": {
28031
- "name": "IRateFieldProps",
28032
- "moduleName": "ui/form/RateField/RateField",
28033
- "title": "RateField",
28034
- "description": "\nПоле для проставления рейтинга\n",
28038
+ "IRadioFieldProps": {
28039
+ "name": "IRadioFieldProps",
28040
+ "moduleName": "ui/form/RadioField/RadioField",
28041
+ "title": "RadioField",
28042
+ "description": "\nКомпонент RadioField представляет собой элемент выбора типа \"radio\". Он позволяет пользователю выбрать один вариант из нескольких предложенных.\n",
28035
28043
  "tags": {},
28036
28044
  "defaultProps": null,
28037
28045
  "extends": [
28038
- "IFieldWrapperInputProps",
28039
- "IUiComponent"
28046
+ "ICheckboxFieldProps"
28040
28047
  ],
28041
28048
  "properties": [
28042
- {
28043
- "name": "allowClear",
28044
- "decorators": [],
28045
- "description": "Возможность полностью сбрасывать рейтинг, при повторном нажатии на звезду",
28046
- "required": false,
28047
- "type": "boolean",
28048
- "example": "false",
28049
- "defaultValue": null
28050
- },
28051
28049
  {
28052
28050
  "name": "attribute",
28053
28051
  "decorators": [],
@@ -28058,12 +28056,12 @@
28058
28056
  "defaultValue": null
28059
28057
  },
28060
28058
  {
28061
- "name": "badge",
28059
+ "name": "checked",
28062
28060
  "decorators": [],
28063
- "description": "Значок (бэйдж) с заголовком.",
28061
+ "description": "Флаг определяющий включен ли элемент",
28064
28062
  "required": false,
28065
- "type": "{title: string}",
28066
- "example": null,
28063
+ "type": "boolean",
28064
+ "example": "true",
28067
28065
  "defaultValue": null
28068
28066
  },
28069
28067
  {
@@ -28076,21 +28074,21 @@
28076
28074
  "defaultValue": null
28077
28075
  },
28078
28076
  {
28079
- "name": "date",
28077
+ "name": "color",
28080
28078
  "decorators": [],
28081
- "description": "",
28079
+ "description": "Пользовательский цвет для чекбокса",
28082
28080
  "required": false,
28083
- "type": "any",
28081
+ "type": "string",
28084
28082
  "example": null,
28085
28083
  "defaultValue": null
28086
28084
  },
28087
28085
  {
28088
- "name": "defaultValue",
28086
+ "name": "date",
28089
28087
  "decorators": [],
28090
- "description": "Количество звезд по умолчанию",
28088
+ "description": "",
28091
28089
  "required": false,
28092
- "type": "number",
28093
- "example": "4",
28090
+ "type": "any",
28091
+ "example": null,
28094
28092
  "defaultValue": null
28095
28093
  },
28096
28094
  {
@@ -28141,10 +28139,10 @@
28141
28139
  {
28142
28140
  "name": "inputProps",
28143
28141
  "decorators": [],
28144
- "description": "",
28142
+ "description": "Свойства для элемента input",
28145
28143
  "required": false,
28146
- "type": "{}",
28147
- "example": null,
28144
+ "type": "any",
28145
+ "example": "{onKeyDown: ...}",
28148
28146
  "defaultValue": null
28149
28147
  },
28150
28148
  {
@@ -28156,15 +28154,6 @@
28156
28154
  "example": null,
28157
28155
  "defaultValue": null
28158
28156
  },
28159
- {
28160
- "name": "itemsCount",
28161
- "decorators": [],
28162
- "description": "Максимальное количество звезд",
28163
- "required": false,
28164
- "type": "number",
28165
- "example": "5",
28166
- "defaultValue": null
28167
- },
28168
28157
  {
28169
28158
  "name": "label",
28170
28159
  "decorators": [],
@@ -28268,41 +28257,52 @@
28268
28257
  }
28269
28258
  ]
28270
28259
  },
28271
- "IRateFieldViewProps": {
28272
- "name": "IRateFieldViewProps",
28273
- "moduleName": "ui/form/RateField/RateField",
28274
- "title": "",
28275
- "description": "",
28260
+ "IRadioListFieldProps": {
28261
+ "name": "IRadioListFieldProps",
28262
+ "moduleName": "ui/form/RadioListField/RadioListField",
28263
+ "title": "RadioListField",
28264
+ "description": "\nСписок с радиокнопками. Используется в формах для выбора одного значения.\n",
28276
28265
  "tags": {},
28277
28266
  "defaultProps": null,
28278
28267
  "extends": [
28279
- "IRateFieldProps",
28280
- "IFieldWrapperOutputProps"
28268
+ "ICheckboxListFieldProps"
28281
28269
  ],
28282
28270
  "properties": [
28283
28271
  {
28284
- "name": "allowClear",
28272
+ "name": "attribute",
28285
28273
  "decorators": [],
28286
- "description": "Возможность полностью сбрасывать рейтинг, при повторном нажатии на звезду",
28274
+ "description": "Аттрибут (название) поля в форме",
28287
28275
  "required": false,
28288
- "type": "boolean",
28289
- "example": "false"
28276
+ "type": "string",
28277
+ "example": "'isVisible'",
28278
+ "defaultValue": null
28290
28279
  },
28291
28280
  {
28292
- "name": "attribute",
28281
+ "name": "autoComplete",
28293
28282
  "decorators": [],
28294
- "description": "Аттрибут (название) поля в форме",
28283
+ "description": "Настройки поиска",
28295
28284
  "required": false,
28296
- "type": "string",
28297
- "example": "'isVisible'"
28285
+ "type": "boolean | IAutoCompleteConfig",
28286
+ "example": "{\n enable: true,\n minLength: 2,\n delay: 100\n}",
28287
+ "defaultValue": null
28298
28288
  },
28299
28289
  {
28300
- "name": "badge",
28290
+ "name": "autoCompleteInputRef",
28301
28291
  "decorators": [],
28302
- "description": "Значок (бэйдж) с заголовком.",
28292
+ "description": "Ref autocomplete поиска",
28303
28293
  "required": false,
28304
- "type": "{title: string}",
28305
- "example": null
28294
+ "type": "MutableRefObject",
28295
+ "example": null,
28296
+ "defaultValue": null
28297
+ },
28298
+ {
28299
+ "name": "autoFetch",
28300
+ "decorators": [],
28301
+ "description": "Загрузка данных после любого изменения запроса.\nЕсли включен autoFetch, то настройки autoComplete не применятся.",
28302
+ "required": false,
28303
+ "type": "boolean",
28304
+ "example": "true",
28305
+ "defaultValue": null
28306
28306
  },
28307
28307
  {
28308
28308
  "name": "className",
@@ -28310,15 +28310,17 @@
28310
28310
  "description": "Дополнительный CSS-класс для элемента отображения",
28311
28311
  "required": false,
28312
28312
  "type": "string",
28313
- "example": null
28313
+ "example": null,
28314
+ "defaultValue": null
28314
28315
  },
28315
28316
  {
28316
- "name": "componentId",
28317
+ "name": "dataProvider",
28317
28318
  "decorators": [],
28318
- "description": "Id компонента",
28319
+ "description": "Конфигурация для подгрузки данных извне.\nЕсли dataProvider не передан, то поиск данных по запросу происходит локально.",
28319
28320
  "required": false,
28320
- "type": "string",
28321
- "example": null
28321
+ "type": "IDataProvider",
28322
+ "example": null,
28323
+ "defaultValue": null
28322
28324
  },
28323
28325
  {
28324
28326
  "name": "date",
@@ -28326,15 +28328,8 @@
28326
28328
  "description": "",
28327
28329
  "required": false,
28328
28330
  "type": "any",
28329
- "example": null
28330
- },
28331
- {
28332
- "name": "defaultValue",
28333
- "decorators": [],
28334
- "description": "Количество звезд по умолчанию",
28335
- "required": false,
28336
- "type": "number",
28337
- "example": "4"
28331
+ "example": null,
28332
+ "defaultValue": null
28338
28333
  },
28339
28334
  {
28340
28335
  "name": "disabled",
@@ -28342,7 +28337,8 @@
28342
28337
  "description": "Переводит элемент в состояние \"не активен\"",
28343
28338
  "required": false,
28344
28339
  "type": "boolean",
28345
- "example": "true"
28340
+ "example": "true",
28341
+ "defaultValue": null
28346
28342
  },
28347
28343
  {
28348
28344
  "name": "errors",
@@ -28350,7 +28346,8 @@
28350
28346
  "description": "Ошибки в поле",
28351
28347
  "required": false,
28352
28348
  "type": "string[]",
28353
- "example": "['Error text']"
28349
+ "example": "['Error text']",
28350
+ "defaultValue": null
28354
28351
  },
28355
28352
  {
28356
28353
  "name": "fieldLayoutClassName",
@@ -28358,15 +28355,26 @@
28358
28355
  "description": "Дополнительный CSS-класс для обертки FieldLayout",
28359
28356
  "required": false,
28360
28357
  "type": "string",
28361
- "example": null
28358
+ "example": null,
28359
+ "defaultValue": null
28362
28360
  },
28363
28361
  {
28364
- "name": "formId",
28362
+ "name": "groupAttribute",
28365
28363
  "decorators": [],
28366
- "description": "Id формы",
28364
+ "description": "Атрибут, в котором должны лежать дочерние элементы списка (для группировки)\nЕсли аттрибут не задан - группировка не производится",
28367
28365
  "required": false,
28368
28366
  "type": "string",
28369
- "example": null
28367
+ "example": "items",
28368
+ "defaultValue": null
28369
+ },
28370
+ {
28371
+ "name": "hasCloseOnSelect",
28372
+ "decorators": [],
28373
+ "description": "Нужно ли закрывать выпадающий список после выбора элемента",
28374
+ "required": false,
28375
+ "type": "boolean",
28376
+ "example": "true",
28377
+ "defaultValue": null
28370
28378
  },
28371
28379
  {
28372
28380
  "name": "hint",
@@ -28374,7 +28382,8 @@
28374
28382
  "description": "Подсказка, которая отобразится рядом с полем",
28375
28383
  "required": false,
28376
28384
  "type": "string",
28377
- "example": "'Only english letters'"
28385
+ "example": "'Only english letters'",
28386
+ "defaultValue": null
28378
28387
  },
28379
28388
  {
28380
28389
  "name": "id",
@@ -28382,52 +28391,685 @@
28382
28391
  "description": "Input ID для связи поля с label",
28383
28392
  "required": false,
28384
28393
  "type": "string",
28385
- "example": null
28394
+ "example": null,
28395
+ "defaultValue": null
28386
28396
  },
28387
28397
  {
28388
- "name": "input",
28398
+ "name": "initialSelectedIds",
28389
28399
  "decorators": [],
28390
- "description": "Параметры для input элемента",
28400
+ "description": "Идентификаторы выбранных значений, которые необходимо подгрузить при `autoFetch` режиме.\nНа бекенд будут переданы идентификаторы в параметре `ids`, которые необходимо вернуть.\nИспользуется только при `autoFetch = true`",
28391
28401
  "required": false,
28392
- "type": "IInputParams",
28393
- "example": null
28402
+ "type": "number[]",
28403
+ "example": "[1, 22]",
28404
+ "defaultValue": null
28394
28405
  },
28395
28406
  {
28396
28407
  "name": "inputProps",
28397
28408
  "decorators": [],
28398
- "description": "",
28409
+ "description": "Свойства для элемента input",
28399
28410
  "required": false,
28400
- "type": "{}",
28401
- "example": null
28411
+ "type": "any",
28412
+ "example": "{ onKeyDown: ... }",
28413
+ "defaultValue": null
28402
28414
  },
28403
28415
  {
28404
- "name": "isRenderWithoutFieldLayout",
28416
+ "name": "inputValue",
28405
28417
  "decorators": [],
28406
- "description": "Возможность отрендерить поле без обертки в компонент FieldLayout",
28418
+ "description": "Значение поля в форме",
28407
28419
  "required": false,
28408
- "type": "boolean",
28409
- "example": null
28420
+ "type": "any",
28421
+ "example": null,
28422
+ "defaultValue": null
28410
28423
  },
28411
28424
  {
28412
- "name": "items",
28425
+ "name": "isFetchDisabled",
28413
28426
  "decorators": [],
28414
- "description": "",
28415
- "required": true,
28416
- "type": "IRateFieldItem[]",
28417
- "example": null
28427
+ "description": "Сигнал, запрещающий отправку запроса на получение данных",
28428
+ "required": false,
28429
+ "type": "boolean",
28430
+ "example": null,
28431
+ "defaultValue": null
28418
28432
  },
28419
28433
  {
28420
- "name": "itemsCount",
28434
+ "name": "isRenderWithoutFieldLayout",
28421
28435
  "decorators": [],
28422
- "description": "Максимальное количество звезд",
28436
+ "description": "Возможность отрендерить поле без обертки в компонент FieldLayout",
28423
28437
  "required": false,
28424
- "type": "number",
28425
- "example": "5"
28438
+ "type": "boolean",
28439
+ "example": null,
28440
+ "defaultValue": null
28426
28441
  },
28427
28442
  {
28428
- "name": "label",
28443
+ "name": "itemView",
28429
28444
  "decorators": [],
28430
- "description": "Название поля либо отмена отображение поля (false)",
28445
+ "description": "Кастомная вьюшка для элемента",
28446
+ "required": false,
28447
+ "type": "React.ReactNode | {}",
28448
+ "example": null,
28449
+ "defaultValue": null
28450
+ },
28451
+ {
28452
+ "name": "itemViewProps",
28453
+ "decorators": [],
28454
+ "description": "Пропсы для отображения элемента",
28455
+ "required": false,
28456
+ "type": "any",
28457
+ "example": null,
28458
+ "defaultValue": null
28459
+ },
28460
+ {
28461
+ "name": "items",
28462
+ "decorators": [],
28463
+ "description": "Коллекция элементов",
28464
+ "required": false,
28465
+ "type": "CheckboxFieldListItems",
28466
+ "example": "[\n {\n id: 1,\n label: 'Krasnoyarsk',\n color: 'red'\n },\n {\n id: 2,\n label: 'Moscow',\n color: 'purple'\n }\n]",
28467
+ "defaultValue": null
28468
+ },
28469
+ {
28470
+ "name": "label",
28471
+ "decorators": [],
28472
+ "description": "Название поля либо отмена отображение поля (false)",
28473
+ "required": false,
28474
+ "type": "any",
28475
+ "example": "'Visible'",
28476
+ "defaultValue": null
28477
+ },
28478
+ {
28479
+ "name": "model",
28480
+ "decorators": [],
28481
+ "description": "Модель с полями формы",
28482
+ "required": false,
28483
+ "type": "any",
28484
+ "example": "{\n attributes: [\n {\n attribute: 'category',\n field: 'DropDownField'\n }\n ]\n}",
28485
+ "defaultValue": null
28486
+ },
28487
+ {
28488
+ "name": "multiple",
28489
+ "decorators": [],
28490
+ "description": "Возможность множественного выбора",
28491
+ "required": false,
28492
+ "type": "boolean",
28493
+ "example": "true",
28494
+ "defaultValue": null
28495
+ },
28496
+ {
28497
+ "name": "orientation",
28498
+ "decorators": [],
28499
+ "description": "Ориентация списка",
28500
+ "required": false,
28501
+ "type": "string",
28502
+ "example": null,
28503
+ "defaultValue": null
28504
+ },
28505
+ {
28506
+ "name": "placeholder",
28507
+ "decorators": [],
28508
+ "description": "Подсказка для поля",
28509
+ "required": false,
28510
+ "type": "string",
28511
+ "example": "Your text...",
28512
+ "defaultValue": null
28513
+ },
28514
+ {
28515
+ "name": "prefix",
28516
+ "decorators": [],
28517
+ "description": "Префикс, который добавится к аттрибуту (названию) поля в форме",
28518
+ "required": false,
28519
+ "type": "string | boolean",
28520
+ "example": null,
28521
+ "defaultValue": null
28522
+ },
28523
+ {
28524
+ "name": "primaryKey",
28525
+ "decorators": [],
28526
+ "description": "Первичный ключ для item",
28527
+ "required": false,
28528
+ "type": "string",
28529
+ "example": "id",
28530
+ "defaultValue": null
28531
+ },
28532
+ {
28533
+ "name": "query",
28534
+ "decorators": [],
28535
+ "description": "Текст запроса",
28536
+ "required": false,
28537
+ "type": "string",
28538
+ "example": "'some text'",
28539
+ "defaultValue": null
28540
+ },
28541
+ {
28542
+ "name": "required",
28543
+ "decorators": [],
28544
+ "description": "Обязательное ли поле? Если true, то к названию будет добавлен\nмодификатор 'required' - красная звездочка (по умолчанию)",
28545
+ "required": false,
28546
+ "type": "boolean",
28547
+ "example": "true",
28548
+ "defaultValue": null
28549
+ },
28550
+ {
28551
+ "name": "selectFirst",
28552
+ "decorators": [],
28553
+ "description": "Сделать активным первый элемент в списке",
28554
+ "required": false,
28555
+ "type": "boolean",
28556
+ "example": "true",
28557
+ "defaultValue": null
28558
+ },
28559
+ {
28560
+ "name": "selectedIds",
28561
+ "decorators": [],
28562
+ "description": "Список с идентификаторами выбранных элементов",
28563
+ "required": false,
28564
+ "type": "any",
28565
+ "example": "[1, 4]",
28566
+ "defaultValue": null
28567
+ },
28568
+ {
28569
+ "name": "size",
28570
+ "decorators": [],
28571
+ "description": "Размер поля",
28572
+ "required": false,
28573
+ "type": "string",
28574
+ "example": null,
28575
+ "defaultValue": null
28576
+ },
28577
+ {
28578
+ "name": "sourceItems",
28579
+ "decorators": [],
28580
+ "description": "Список со всеми элементами",
28581
+ "required": false,
28582
+ "type": "IDataSelectItem[]",
28583
+ "example": null,
28584
+ "defaultValue": null
28585
+ },
28586
+ {
28587
+ "name": "style",
28588
+ "decorators": [],
28589
+ "description": "Объект CSS стилей",
28590
+ "required": false,
28591
+ "type": "CSSProperties",
28592
+ "example": "{width: '45%'}",
28593
+ "defaultValue": null
28594
+ },
28595
+ {
28596
+ "name": "value",
28597
+ "decorators": [],
28598
+ "description": "Значение для поля",
28599
+ "required": false,
28600
+ "type": "any",
28601
+ "example": null,
28602
+ "defaultValue": null
28603
+ },
28604
+ {
28605
+ "name": "view",
28606
+ "decorators": [],
28607
+ "description": "Переопределение view React компонента для кастомизации отображения",
28608
+ "required": false,
28609
+ "type": "React.ReactNode | {}",
28610
+ "example": "MyCustomView",
28611
+ "defaultValue": null
28612
+ },
28613
+ {
28614
+ "name": "viewProps",
28615
+ "decorators": [],
28616
+ "description": "Свойства для компонента отображения",
28617
+ "required": false,
28618
+ "type": "{}",
28619
+ "example": "{\n customHandler: () => {...}\n}",
28620
+ "defaultValue": null
28621
+ }
28622
+ ],
28623
+ "methods": [
28624
+ {
28625
+ "name": "onChange",
28626
+ "decorators": [],
28627
+ "description": "Callback-функция, которая вызывается при изменении данных",
28628
+ "required": false,
28629
+ "type": "any",
28630
+ "example": null,
28631
+ "parameters": [
28632
+ {
28633
+ "name": "args",
28634
+ "decorators": [],
28635
+ "description": "",
28636
+ "required": true,
28637
+ "type": "any[]",
28638
+ "example": null
28639
+ }
28640
+ ]
28641
+ }
28642
+ ]
28643
+ },
28644
+ "IRateFieldItem": {
28645
+ "name": "IRateFieldItem",
28646
+ "moduleName": "ui/form/RateField/RateField",
28647
+ "title": "",
28648
+ "description": "",
28649
+ "tags": {},
28650
+ "defaultProps": null,
28651
+ "extends": [],
28652
+ "properties": [
28653
+ {
28654
+ "name": "id",
28655
+ "decorators": [],
28656
+ "description": "",
28657
+ "required": true,
28658
+ "type": "number",
28659
+ "example": null
28660
+ },
28661
+ {
28662
+ "name": "value",
28663
+ "decorators": [],
28664
+ "description": "",
28665
+ "required": true,
28666
+ "type": "number",
28667
+ "example": null
28668
+ }
28669
+ ],
28670
+ "methods": []
28671
+ },
28672
+ "IRateFieldProps": {
28673
+ "name": "IRateFieldProps",
28674
+ "moduleName": "ui/form/RateField/RateField",
28675
+ "title": "RateField",
28676
+ "description": "\nПоле для проставления рейтинга\n",
28677
+ "tags": {},
28678
+ "defaultProps": null,
28679
+ "extends": [
28680
+ "IFieldWrapperInputProps",
28681
+ "IUiComponent"
28682
+ ],
28683
+ "properties": [
28684
+ {
28685
+ "name": "allowClear",
28686
+ "decorators": [],
28687
+ "description": "Возможность полностью сбрасывать рейтинг, при повторном нажатии на звезду",
28688
+ "required": false,
28689
+ "type": "boolean",
28690
+ "example": "false",
28691
+ "defaultValue": null
28692
+ },
28693
+ {
28694
+ "name": "attribute",
28695
+ "decorators": [],
28696
+ "description": "Аттрибут (название) поля в форме",
28697
+ "required": false,
28698
+ "type": "string",
28699
+ "example": "'isVisible'",
28700
+ "defaultValue": null
28701
+ },
28702
+ {
28703
+ "name": "badge",
28704
+ "decorators": [],
28705
+ "description": "Значок (бэйдж) с заголовком.",
28706
+ "required": false,
28707
+ "type": "{title: string}",
28708
+ "example": null,
28709
+ "defaultValue": null
28710
+ },
28711
+ {
28712
+ "name": "className",
28713
+ "decorators": [],
28714
+ "description": "Дополнительный CSS-класс для элемента отображения",
28715
+ "required": false,
28716
+ "type": "string",
28717
+ "example": null,
28718
+ "defaultValue": null
28719
+ },
28720
+ {
28721
+ "name": "date",
28722
+ "decorators": [],
28723
+ "description": "",
28724
+ "required": false,
28725
+ "type": "any",
28726
+ "example": null,
28727
+ "defaultValue": null
28728
+ },
28729
+ {
28730
+ "name": "defaultValue",
28731
+ "decorators": [],
28732
+ "description": "Количество звезд по умолчанию",
28733
+ "required": false,
28734
+ "type": "number",
28735
+ "example": "4",
28736
+ "defaultValue": null
28737
+ },
28738
+ {
28739
+ "name": "disabled",
28740
+ "decorators": [],
28741
+ "description": "Переводит элемент в состояние \"не активен\"",
28742
+ "required": false,
28743
+ "type": "boolean",
28744
+ "example": "true",
28745
+ "defaultValue": null
28746
+ },
28747
+ {
28748
+ "name": "errors",
28749
+ "decorators": [],
28750
+ "description": "Ошибки в поле",
28751
+ "required": false,
28752
+ "type": "string[]",
28753
+ "example": "['Error text']",
28754
+ "defaultValue": null
28755
+ },
28756
+ {
28757
+ "name": "fieldLayoutClassName",
28758
+ "decorators": [],
28759
+ "description": "Дополнительный CSS-класс для обертки FieldLayout",
28760
+ "required": false,
28761
+ "type": "string",
28762
+ "example": null,
28763
+ "defaultValue": null
28764
+ },
28765
+ {
28766
+ "name": "hint",
28767
+ "decorators": [],
28768
+ "description": "Подсказка, которая отобразится рядом с полем",
28769
+ "required": false,
28770
+ "type": "string",
28771
+ "example": "'Only english letters'",
28772
+ "defaultValue": null
28773
+ },
28774
+ {
28775
+ "name": "id",
28776
+ "decorators": [],
28777
+ "description": "Input ID для связи поля с label",
28778
+ "required": false,
28779
+ "type": "string",
28780
+ "example": null,
28781
+ "defaultValue": null
28782
+ },
28783
+ {
28784
+ "name": "inputProps",
28785
+ "decorators": [],
28786
+ "description": "",
28787
+ "required": false,
28788
+ "type": "{}",
28789
+ "example": null,
28790
+ "defaultValue": null
28791
+ },
28792
+ {
28793
+ "name": "isRenderWithoutFieldLayout",
28794
+ "decorators": [],
28795
+ "description": "Возможность отрендерить поле без обертки в компонент FieldLayout",
28796
+ "required": false,
28797
+ "type": "boolean",
28798
+ "example": null,
28799
+ "defaultValue": null
28800
+ },
28801
+ {
28802
+ "name": "itemsCount",
28803
+ "decorators": [],
28804
+ "description": "Максимальное количество звезд",
28805
+ "required": false,
28806
+ "type": "number",
28807
+ "example": "5",
28808
+ "defaultValue": null
28809
+ },
28810
+ {
28811
+ "name": "label",
28812
+ "decorators": [],
28813
+ "description": "Название поля либо отмена отображение поля (false)",
28814
+ "required": false,
28815
+ "type": "any",
28816
+ "example": "'Visible'",
28817
+ "defaultValue": null
28818
+ },
28819
+ {
28820
+ "name": "model",
28821
+ "decorators": [],
28822
+ "description": "Модель с полями формы",
28823
+ "required": false,
28824
+ "type": "any",
28825
+ "example": "{\n attributes: [\n {\n attribute: 'category',\n field: 'DropDownField'\n }\n ]\n}",
28826
+ "defaultValue": null
28827
+ },
28828
+ {
28829
+ "name": "placeholder",
28830
+ "decorators": [],
28831
+ "description": "Подсказка для поля",
28832
+ "required": false,
28833
+ "type": "string",
28834
+ "example": "Your text...",
28835
+ "defaultValue": null
28836
+ },
28837
+ {
28838
+ "name": "prefix",
28839
+ "decorators": [],
28840
+ "description": "Префикс, который добавится к аттрибуту (названию) поля в форме",
28841
+ "required": false,
28842
+ "type": "string | boolean",
28843
+ "example": null,
28844
+ "defaultValue": null
28845
+ },
28846
+ {
28847
+ "name": "required",
28848
+ "decorators": [],
28849
+ "description": "Обязательное ли поле? Если true, то к названию будет добавлен\nмодификатор 'required' - красная звездочка (по умолчанию)",
28850
+ "required": false,
28851
+ "type": "boolean",
28852
+ "example": "true",
28853
+ "defaultValue": null
28854
+ },
28855
+ {
28856
+ "name": "size",
28857
+ "decorators": [],
28858
+ "description": "Размер поля",
28859
+ "required": false,
28860
+ "type": "string",
28861
+ "example": null,
28862
+ "defaultValue": null
28863
+ },
28864
+ {
28865
+ "name": "style",
28866
+ "decorators": [],
28867
+ "description": "Объект CSS стилей",
28868
+ "required": false,
28869
+ "type": "CSSProperties",
28870
+ "example": "{width: '45%'}",
28871
+ "defaultValue": null
28872
+ },
28873
+ {
28874
+ "name": "value",
28875
+ "decorators": [],
28876
+ "description": "Значение для поля",
28877
+ "required": false,
28878
+ "type": "any",
28879
+ "example": null,
28880
+ "defaultValue": null
28881
+ },
28882
+ {
28883
+ "name": "view",
28884
+ "decorators": [],
28885
+ "description": "Переопределение view React компонента для кастомизации отображения",
28886
+ "required": false,
28887
+ "type": "React.ReactNode | {}",
28888
+ "example": "MyCustomView",
28889
+ "defaultValue": null
28890
+ }
28891
+ ],
28892
+ "methods": [
28893
+ {
28894
+ "name": "onChange",
28895
+ "decorators": [],
28896
+ "description": "Callback-функция, которая вызывается при изменении данных",
28897
+ "required": false,
28898
+ "type": "any",
28899
+ "example": null,
28900
+ "parameters": [
28901
+ {
28902
+ "name": "args",
28903
+ "decorators": [],
28904
+ "description": "",
28905
+ "required": true,
28906
+ "type": "any[]",
28907
+ "example": null
28908
+ }
28909
+ ]
28910
+ }
28911
+ ]
28912
+ },
28913
+ "IRateFieldViewProps": {
28914
+ "name": "IRateFieldViewProps",
28915
+ "moduleName": "ui/form/RateField/RateField",
28916
+ "title": "",
28917
+ "description": "",
28918
+ "tags": {},
28919
+ "defaultProps": null,
28920
+ "extends": [
28921
+ "IRateFieldProps",
28922
+ "IFieldWrapperOutputProps"
28923
+ ],
28924
+ "properties": [
28925
+ {
28926
+ "name": "allowClear",
28927
+ "decorators": [],
28928
+ "description": "Возможность полностью сбрасывать рейтинг, при повторном нажатии на звезду",
28929
+ "required": false,
28930
+ "type": "boolean",
28931
+ "example": "false"
28932
+ },
28933
+ {
28934
+ "name": "attribute",
28935
+ "decorators": [],
28936
+ "description": "Аттрибут (название) поля в форме",
28937
+ "required": false,
28938
+ "type": "string",
28939
+ "example": "'isVisible'"
28940
+ },
28941
+ {
28942
+ "name": "badge",
28943
+ "decorators": [],
28944
+ "description": "Значок (бэйдж) с заголовком.",
28945
+ "required": false,
28946
+ "type": "{title: string}",
28947
+ "example": null
28948
+ },
28949
+ {
28950
+ "name": "className",
28951
+ "decorators": [],
28952
+ "description": "Дополнительный CSS-класс для элемента отображения",
28953
+ "required": false,
28954
+ "type": "string",
28955
+ "example": null
28956
+ },
28957
+ {
28958
+ "name": "componentId",
28959
+ "decorators": [],
28960
+ "description": "Id компонента",
28961
+ "required": false,
28962
+ "type": "string",
28963
+ "example": null
28964
+ },
28965
+ {
28966
+ "name": "date",
28967
+ "decorators": [],
28968
+ "description": "",
28969
+ "required": false,
28970
+ "type": "any",
28971
+ "example": null
28972
+ },
28973
+ {
28974
+ "name": "defaultValue",
28975
+ "decorators": [],
28976
+ "description": "Количество звезд по умолчанию",
28977
+ "required": false,
28978
+ "type": "number",
28979
+ "example": "4"
28980
+ },
28981
+ {
28982
+ "name": "disabled",
28983
+ "decorators": [],
28984
+ "description": "Переводит элемент в состояние \"не активен\"",
28985
+ "required": false,
28986
+ "type": "boolean",
28987
+ "example": "true"
28988
+ },
28989
+ {
28990
+ "name": "errors",
28991
+ "decorators": [],
28992
+ "description": "Ошибки в поле",
28993
+ "required": false,
28994
+ "type": "string[]",
28995
+ "example": "['Error text']"
28996
+ },
28997
+ {
28998
+ "name": "fieldLayoutClassName",
28999
+ "decorators": [],
29000
+ "description": "Дополнительный CSS-класс для обертки FieldLayout",
29001
+ "required": false,
29002
+ "type": "string",
29003
+ "example": null
29004
+ },
29005
+ {
29006
+ "name": "formId",
29007
+ "decorators": [],
29008
+ "description": "Id формы",
29009
+ "required": false,
29010
+ "type": "string",
29011
+ "example": null
29012
+ },
29013
+ {
29014
+ "name": "hint",
29015
+ "decorators": [],
29016
+ "description": "Подсказка, которая отобразится рядом с полем",
29017
+ "required": false,
29018
+ "type": "string",
29019
+ "example": "'Only english letters'"
29020
+ },
29021
+ {
29022
+ "name": "id",
29023
+ "decorators": [],
29024
+ "description": "Input ID для связи поля с label",
29025
+ "required": false,
29026
+ "type": "string",
29027
+ "example": null
29028
+ },
29029
+ {
29030
+ "name": "input",
29031
+ "decorators": [],
29032
+ "description": "Параметры для input элемента",
29033
+ "required": false,
29034
+ "type": "IInputParams",
29035
+ "example": null
29036
+ },
29037
+ {
29038
+ "name": "inputProps",
29039
+ "decorators": [],
29040
+ "description": "",
29041
+ "required": false,
29042
+ "type": "{}",
29043
+ "example": null
29044
+ },
29045
+ {
29046
+ "name": "isRenderWithoutFieldLayout",
29047
+ "decorators": [],
29048
+ "description": "Возможность отрендерить поле без обертки в компонент FieldLayout",
29049
+ "required": false,
29050
+ "type": "boolean",
29051
+ "example": null
29052
+ },
29053
+ {
29054
+ "name": "items",
29055
+ "decorators": [],
29056
+ "description": "",
29057
+ "required": true,
29058
+ "type": "IRateFieldItem[]",
29059
+ "example": null
29060
+ },
29061
+ {
29062
+ "name": "itemsCount",
29063
+ "decorators": [],
29064
+ "description": "Максимальное количество звезд",
29065
+ "required": false,
29066
+ "type": "number",
29067
+ "example": "5"
29068
+ },
29069
+ {
29070
+ "name": "label",
29071
+ "decorators": [],
29072
+ "description": "Название поля либо отмена отображение поля (false)",
28431
29073
  "required": false,
28432
29074
  "type": "any",
28433
29075
  "example": "'Visible'"
@@ -29723,6 +30365,228 @@
29723
30365
  }
29724
30366
  ]
29725
30367
  },
30368
+ "ISwitcherFieldProps": {
30369
+ "name": "ISwitcherFieldProps",
30370
+ "moduleName": "ui/form/SwitcherField/SwitcherField",
30371
+ "title": "SwitcherField",
30372
+ "description": "\nКомпонент SwitcherField представляет собой переключатель (switch/toggle),\nкоторый позволяет пользователю включать или выключать значение (boolean).\nОбычно используется для управления настройками, параметрами или состояниями\n«вкл / выкл».\n",
30373
+ "tags": {},
30374
+ "defaultProps": null,
30375
+ "extends": [
30376
+ "ICheckboxFieldProps"
30377
+ ],
30378
+ "properties": [
30379
+ {
30380
+ "name": "attribute",
30381
+ "decorators": [],
30382
+ "description": "Аттрибут (название) поля в форме",
30383
+ "required": false,
30384
+ "type": "string",
30385
+ "example": "'isVisible'",
30386
+ "defaultValue": null
30387
+ },
30388
+ {
30389
+ "name": "checked",
30390
+ "decorators": [],
30391
+ "description": "Флаг определяющий включен ли элемент",
30392
+ "required": false,
30393
+ "type": "boolean",
30394
+ "example": "true",
30395
+ "defaultValue": null
30396
+ },
30397
+ {
30398
+ "name": "className",
30399
+ "decorators": [],
30400
+ "description": "Дополнительный CSS-класс для элемента отображения",
30401
+ "required": false,
30402
+ "type": "string",
30403
+ "example": null,
30404
+ "defaultValue": null
30405
+ },
30406
+ {
30407
+ "name": "color",
30408
+ "decorators": [],
30409
+ "description": "Пользовательский цвет для чекбокса",
30410
+ "required": false,
30411
+ "type": "string",
30412
+ "example": null,
30413
+ "defaultValue": null
30414
+ },
30415
+ {
30416
+ "name": "date",
30417
+ "decorators": [],
30418
+ "description": "",
30419
+ "required": false,
30420
+ "type": "any",
30421
+ "example": null,
30422
+ "defaultValue": null
30423
+ },
30424
+ {
30425
+ "name": "disabled",
30426
+ "decorators": [],
30427
+ "description": "Переводит элемент в состояние \"не активен\"",
30428
+ "required": false,
30429
+ "type": "boolean",
30430
+ "example": "true",
30431
+ "defaultValue": null
30432
+ },
30433
+ {
30434
+ "name": "errors",
30435
+ "decorators": [],
30436
+ "description": "Ошибки в поле",
30437
+ "required": false,
30438
+ "type": "string[]",
30439
+ "example": "['Error text']",
30440
+ "defaultValue": null
30441
+ },
30442
+ {
30443
+ "name": "fieldLayoutClassName",
30444
+ "decorators": [],
30445
+ "description": "Дополнительный CSS-класс для обертки FieldLayout",
30446
+ "required": false,
30447
+ "type": "string",
30448
+ "example": null,
30449
+ "defaultValue": null
30450
+ },
30451
+ {
30452
+ "name": "hint",
30453
+ "decorators": [],
30454
+ "description": "Подсказка, которая отобразится рядом с полем",
30455
+ "required": false,
30456
+ "type": "string",
30457
+ "example": "'Only english letters'",
30458
+ "defaultValue": null
30459
+ },
30460
+ {
30461
+ "name": "id",
30462
+ "decorators": [],
30463
+ "description": "Input ID для связи поля с label",
30464
+ "required": false,
30465
+ "type": "string",
30466
+ "example": null,
30467
+ "defaultValue": null
30468
+ },
30469
+ {
30470
+ "name": "inputProps",
30471
+ "decorators": [],
30472
+ "description": "Свойства для элемента input",
30473
+ "required": false,
30474
+ "type": "any",
30475
+ "example": "{onKeyDown: ...}",
30476
+ "defaultValue": null
30477
+ },
30478
+ {
30479
+ "name": "isRenderWithoutFieldLayout",
30480
+ "decorators": [],
30481
+ "description": "Возможность отрендерить поле без обертки в компонент FieldLayout",
30482
+ "required": false,
30483
+ "type": "boolean",
30484
+ "example": null,
30485
+ "defaultValue": null
30486
+ },
30487
+ {
30488
+ "name": "label",
30489
+ "decorators": [],
30490
+ "description": "Название поля либо отмена отображение поля (false)",
30491
+ "required": false,
30492
+ "type": "any",
30493
+ "example": "'Visible'",
30494
+ "defaultValue": null
30495
+ },
30496
+ {
30497
+ "name": "model",
30498
+ "decorators": [],
30499
+ "description": "Модель с полями формы",
30500
+ "required": false,
30501
+ "type": "any",
30502
+ "example": "{\n attributes: [\n {\n attribute: 'category',\n field: 'DropDownField'\n }\n ]\n}",
30503
+ "defaultValue": null
30504
+ },
30505
+ {
30506
+ "name": "placeholder",
30507
+ "decorators": [],
30508
+ "description": "Подсказка для поля",
30509
+ "required": false,
30510
+ "type": "string",
30511
+ "example": "Your text...",
30512
+ "defaultValue": null
30513
+ },
30514
+ {
30515
+ "name": "prefix",
30516
+ "decorators": [],
30517
+ "description": "Префикс, который добавится к аттрибуту (названию) поля в форме",
30518
+ "required": false,
30519
+ "type": "string | boolean",
30520
+ "example": null,
30521
+ "defaultValue": null
30522
+ },
30523
+ {
30524
+ "name": "required",
30525
+ "decorators": [],
30526
+ "description": "Обязательное ли поле? Если true, то к названию будет добавлен\nмодификатор 'required' - красная звездочка (по умолчанию)",
30527
+ "required": false,
30528
+ "type": "boolean",
30529
+ "example": "true",
30530
+ "defaultValue": null
30531
+ },
30532
+ {
30533
+ "name": "size",
30534
+ "decorators": [],
30535
+ "description": "Размер поля",
30536
+ "required": false,
30537
+ "type": "string",
30538
+ "example": null,
30539
+ "defaultValue": null
30540
+ },
30541
+ {
30542
+ "name": "style",
30543
+ "decorators": [],
30544
+ "description": "Объект CSS стилей",
30545
+ "required": false,
30546
+ "type": "CSSProperties",
30547
+ "example": "{width: '45%'}",
30548
+ "defaultValue": null
30549
+ },
30550
+ {
30551
+ "name": "value",
30552
+ "decorators": [],
30553
+ "description": "Значение для поля",
30554
+ "required": false,
30555
+ "type": "any",
30556
+ "example": null,
30557
+ "defaultValue": null
30558
+ },
30559
+ {
30560
+ "name": "view",
30561
+ "decorators": [],
30562
+ "description": "Переопределение view React компонента для кастомизации отображения",
30563
+ "required": false,
30564
+ "type": "React.ReactNode | {}",
30565
+ "example": "MyCustomView",
30566
+ "defaultValue": null
30567
+ }
30568
+ ],
30569
+ "methods": [
30570
+ {
30571
+ "name": "onChange",
30572
+ "decorators": [],
30573
+ "description": "Callback-функция, которая вызывается при изменении данных",
30574
+ "required": false,
30575
+ "type": "any",
30576
+ "example": null,
30577
+ "parameters": [
30578
+ {
30579
+ "name": "args",
30580
+ "decorators": [],
30581
+ "description": "",
30582
+ "required": true,
30583
+ "type": "any[]",
30584
+ "example": null
30585
+ }
30586
+ ]
30587
+ }
30588
+ ]
30589
+ },
29726
30590
  "ITextFieldProps": {
29727
30591
  "name": "ITextFieldProps",
29728
30592
  "moduleName": "ui/form/TextField/TextField",