@steroidsjs/core 3.0.0-beta.65 → 3.0.0-beta.67

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.
@@ -657,6 +657,14 @@
657
657
  "type": "Omit",
658
658
  "example": null
659
659
  },
660
+ {
661
+ "name": "theme",
662
+ "decorators": [],
663
+ "description": "",
664
+ "required": false,
665
+ "type": "Omit",
666
+ "example": null
667
+ },
660
668
  {
661
669
  "name": "useGlobal",
662
670
  "decorators": [],
@@ -1158,14 +1166,14 @@
1158
1166
  "decorators": [],
1159
1167
  "description": "",
1160
1168
  "required": false,
1161
- "type": "any",
1169
+ "type": "T | {providerData: {type: string, value: string}}",
1162
1170
  "example": null
1163
1171
  },
1164
1172
  {
1165
1173
  "name": "fetch",
1166
1174
  "decorators": [],
1167
1175
  "description": "",
1168
- "required": false,
1176
+ "required": true,
1169
1177
  "type": "{}",
1170
1178
  "example": null
1171
1179
  },
@@ -2051,6 +2059,70 @@
2051
2059
  }
2052
2060
  ]
2053
2061
  },
2062
+ "ITheme": {
2063
+ "name": "ITheme",
2064
+ "moduleName": "providers/ThemeProvider",
2065
+ "title": "",
2066
+ "description": "",
2067
+ "tags": {},
2068
+ "defaultProps": null,
2069
+ "extends": [],
2070
+ "properties": [
2071
+ {
2072
+ "name": "setTheme",
2073
+ "decorators": [],
2074
+ "description": "",
2075
+ "required": true,
2076
+ "type": "Dispatch",
2077
+ "example": null
2078
+ },
2079
+ {
2080
+ "name": "theme",
2081
+ "decorators": [],
2082
+ "description": "",
2083
+ "required": true,
2084
+ "type": "string",
2085
+ "example": null
2086
+ },
2087
+ {
2088
+ "name": "toggleTheme",
2089
+ "decorators": [],
2090
+ "description": "",
2091
+ "required": true,
2092
+ "type": "VoidFunction",
2093
+ "example": null
2094
+ }
2095
+ ]
2096
+ },
2097
+ "IThemeProviderProps": {
2098
+ "name": "IThemeProviderProps",
2099
+ "moduleName": "providers/ThemeProvider",
2100
+ "title": "",
2101
+ "description": "",
2102
+ "tags": {},
2103
+ "defaultProps": null,
2104
+ "extends": [
2105
+ "React.PropsWithChildren<any>"
2106
+ ],
2107
+ "properties": [
2108
+ {
2109
+ "name": "themeStorageKey",
2110
+ "decorators": [],
2111
+ "description": "",
2112
+ "required": false,
2113
+ "type": "string",
2114
+ "example": null
2115
+ },
2116
+ {
2117
+ "name": "themes",
2118
+ "decorators": [],
2119
+ "description": "",
2120
+ "required": false,
2121
+ "type": "string[]",
2122
+ "example": null
2123
+ }
2124
+ ]
2125
+ },
2054
2126
  "IFieldsState": {
2055
2127
  "name": "IFieldsState",
2056
2128
  "moduleName": "reducers/fields",
@@ -20752,6 +20824,107 @@
20752
20824
  "IUiComponent"
20753
20825
  ],
20754
20826
  "properties": [
20827
+ {
20828
+ "name": "authParams",
20829
+ "decorators": [],
20830
+ "description": "Параметры авторизации.",
20831
+ "required": false,
20832
+ "type": "{buttonProps: IButtonProps, isAuth: boolean, modal: IModalProps, toRoute: string}",
20833
+ "example": null
20834
+ },
20835
+ {
20836
+ "name": "burgerMenu",
20837
+ "decorators": [],
20838
+ "description": "Свойства для бургер-меню.",
20839
+ "required": false,
20840
+ "type": "{content: ReactElement, links: ILinkProps}",
20841
+ "example": null
20842
+ },
20843
+ {
20844
+ "name": "className",
20845
+ "decorators": [],
20846
+ "description": "Дополнительный CSS-класс для элемента отображения",
20847
+ "required": false,
20848
+ "type": "string",
20849
+ "example": null
20850
+ },
20851
+ {
20852
+ "name": "logo",
20853
+ "decorators": [],
20854
+ "description": "Свойства для логотипа.",
20855
+ "required": false,
20856
+ "type": "{className: string, icon: string | ReactElement, linkProps: ILinkProps, title: string}",
20857
+ "example": null
20858
+ },
20859
+ {
20860
+ "name": "nav",
20861
+ "decorators": [],
20862
+ "description": "Свойства для навигации",
20863
+ "required": false,
20864
+ "type": "INavProps",
20865
+ "example": null
20866
+ },
20867
+ {
20868
+ "name": "size",
20869
+ "decorators": [],
20870
+ "description": "Размер",
20871
+ "required": false,
20872
+ "type": "string",
20873
+ "example": null
20874
+ },
20875
+ {
20876
+ "name": "style",
20877
+ "decorators": [],
20878
+ "description": "Объект CSS стилей",
20879
+ "required": false,
20880
+ "type": "CSSProperties",
20881
+ "example": "{width: '45%'}"
20882
+ },
20883
+ {
20884
+ "name": "user",
20885
+ "decorators": [],
20886
+ "description": "Информация о пользователе.",
20887
+ "required": false,
20888
+ "type": "{avatar: IAvatarProps, menu: IMenuProps, name: string}",
20889
+ "example": null
20890
+ },
20891
+ {
20892
+ "name": "view",
20893
+ "decorators": [],
20894
+ "description": "Переопределение view React компонента для кастомизации отображения",
20895
+ "required": false,
20896
+ "type": "React.ReactNode | {}",
20897
+ "example": "MyCustomView"
20898
+ }
20899
+ ]
20900
+ },
20901
+ "IHeaderViewProps": {
20902
+ "name": "IHeaderViewProps",
20903
+ "moduleName": "ui/layout/Header/Header",
20904
+ "title": "",
20905
+ "description": "",
20906
+ "tags": {},
20907
+ "defaultProps": null,
20908
+ "extends": [
20909
+ "IHeaderProps"
20910
+ ],
20911
+ "properties": [
20912
+ {
20913
+ "name": "authParams",
20914
+ "decorators": [],
20915
+ "description": "Параметры авторизации.",
20916
+ "required": false,
20917
+ "type": "{buttonProps: IButtonProps, isAuth: boolean, modal: IModalProps, toRoute: string}",
20918
+ "example": null
20919
+ },
20920
+ {
20921
+ "name": "burgerMenu",
20922
+ "decorators": [],
20923
+ "description": "Свойства для бургер-меню.",
20924
+ "required": false,
20925
+ "type": "{content: ReactElement, links: ILinkProps}",
20926
+ "example": null
20927
+ },
20755
20928
  {
20756
20929
  "name": "className",
20757
20930
  "decorators": [],
@@ -20760,12 +20933,20 @@
20760
20933
  "type": "string",
20761
20934
  "example": null
20762
20935
  },
20936
+ {
20937
+ "name": "isBurgerOpened",
20938
+ "decorators": [],
20939
+ "description": "",
20940
+ "required": true,
20941
+ "type": "boolean",
20942
+ "example": null
20943
+ },
20763
20944
  {
20764
20945
  "name": "logo",
20765
20946
  "decorators": [],
20766
- "description": "Свойства для логотипа",
20947
+ "description": "Свойства для логотипа.",
20767
20948
  "required": false,
20768
- "type": "{className: string, icon: any, linkProps: Record, title: string}",
20949
+ "type": "{className: string, icon: string | ReactElement, linkProps: ILinkProps, title: string}",
20769
20950
  "example": null
20770
20951
  },
20771
20952
  {
@@ -20792,6 +20973,22 @@
20792
20973
  "type": "CSSProperties",
20793
20974
  "example": "{width: '45%'}"
20794
20975
  },
20976
+ {
20977
+ "name": "toggleBurger",
20978
+ "decorators": [],
20979
+ "description": "",
20980
+ "required": true,
20981
+ "type": "VoidFunction",
20982
+ "example": null
20983
+ },
20984
+ {
20985
+ "name": "user",
20986
+ "decorators": [],
20987
+ "description": "Информация о пользователе.",
20988
+ "required": false,
20989
+ "type": "{avatar: IAvatarProps, menu: IMenuProps, name: string}",
20990
+ "example": null
20991
+ },
20795
20992
  {
20796
20993
  "name": "view",
20797
20994
  "decorators": [],
@@ -21110,102 +21307,637 @@
21110
21307
  }
21111
21308
  ]
21112
21309
  },
21113
- "ISkeletonProps": {
21114
- "name": "ISkeletonProps",
21115
- "moduleName": "ui/layout/Skeleton/Skeleton",
21116
- "title": "Компонент Skeleton представляет собой заглушку для отображения временных данных",
21117
- "description": "во время загрузки или ожидания загрузки реальных данных.",
21310
+ "ISidebarItem": {
21311
+ "name": "ISidebarItem",
21312
+ "moduleName": "ui/layout/Sidebar/Sidebar",
21313
+ "title": "",
21314
+ "description": "",
21118
21315
  "tags": {},
21119
21316
  "defaultProps": null,
21120
- "extends": [],
21317
+ "extends": [
21318
+ "INavItem"
21319
+ ],
21121
21320
  "properties": [
21122
21321
  {
21123
- "name": "animation",
21322
+ "name": "badge",
21124
21323
  "decorators": [],
21125
- "description": "Тип анимации",
21324
+ "description": "Цифра (к примеру, новые сообщения)",
21126
21325
  "required": false,
21127
- "type": "\"pulse\" | \"wave\"",
21326
+ "type": "number | IButtonBadge",
21128
21327
  "example": null
21129
21328
  },
21130
21329
  {
21131
- "name": "children",
21330
+ "name": "block",
21132
21331
  "decorators": [],
21133
- "description": "Дочерние элементы",
21332
+ "description": "Включает стиль `block`, делая размер кнопки на 100% ширины блока",
21134
21333
  "required": false,
21135
- "type": "ReactNode",
21136
- "example": null
21334
+ "type": "boolean",
21335
+ "example": "true"
21137
21336
  },
21138
21337
  {
21139
- "name": "className",
21338
+ "name": "border",
21140
21339
  "decorators": [],
21141
- "description": "Дополнительные CSS классы",
21340
+ "description": "Наличие верней границы у элемента",
21142
21341
  "required": false,
21143
- "type": "string",
21144
- "example": "my-block"
21342
+ "type": "boolean",
21343
+ "example": null
21145
21344
  },
21146
21345
  {
21147
- "name": "height",
21346
+ "name": "children",
21148
21347
  "decorators": [],
21149
- "description": "Высота элемента",
21348
+ "description": "Вложенные элементы",
21150
21349
  "required": false,
21151
- "type": "string | number",
21350
+ "type": "any",
21152
21351
  "example": null
21153
21352
  },
21154
21353
  {
21155
- "name": "type",
21354
+ "name": "className",
21156
21355
  "decorators": [],
21157
- "description": "Тип компонента",
21356
+ "description": "CSS-класс для элемента отображения",
21158
21357
  "required": false,
21159
- "type": "\"circle\" | \"rect\" | \"text\"",
21358
+ "type": "string",
21160
21359
  "example": null
21161
21360
  },
21162
21361
  {
21163
- "name": "width",
21362
+ "name": "color",
21164
21363
  "decorators": [],
21165
- "description": "Ширина элемента",
21364
+ "description": "Цвет состояния",
21166
21365
  "required": false,
21167
- "type": "string | number",
21168
- "example": null
21169
- }
21170
- ]
21171
- },
21172
- "ISkeletonViewProps": {
21173
- "name": "ISkeletonViewProps",
21174
- "moduleName": "ui/layout/Skeleton/Skeleton",
21175
- "title": "",
21176
- "description": "",
21177
- "tags": {},
21178
- "defaultProps": null,
21179
- "extends": [],
21180
- "properties": [
21366
+ "type": "string",
21367
+ "example": "success"
21368
+ },
21181
21369
  {
21182
- "name": "animation",
21370
+ "name": "confirm",
21183
21371
  "decorators": [],
21184
- "description": "",
21372
+ "description": "При указании данного свойства, после нажатия на кнопку и до выполнения действия будет отображено нативное\nокно с текстом подтверждения - `window.confirm('Ваш текст')`.",
21185
21373
  "required": false,
21186
- "type": "\"pulse\" | \"wave\"",
21187
- "example": null
21374
+ "type": "string",
21375
+ "example": "Удалить запись #512?"
21188
21376
  },
21189
21377
  {
21190
- "name": "children",
21378
+ "name": "content",
21191
21379
  "decorators": [],
21192
- "description": "",
21380
+ "description": "Контент, который отобразиться, если элемент навигации будет активен",
21193
21381
  "required": false,
21194
- "type": "ReactNode",
21195
- "example": null
21382
+ "type": "any",
21383
+ "example": "ContentComponent"
21196
21384
  },
21197
21385
  {
21198
- "name": "className",
21386
+ "name": "contentProps",
21199
21387
  "decorators": [],
21200
- "description": "",
21388
+ "description": "Свойства для компонента с контентом",
21201
21389
  "required": false,
21202
- "type": "string",
21203
- "example": null
21390
+ "type": "any",
21391
+ "example": "{content: 'Some text'}"
21204
21392
  },
21205
21393
  {
21206
- "name": "height",
21394
+ "name": "dark",
21207
21395
  "decorators": [],
21208
- "description": "",
21396
+ "description": "Темная тема",
21397
+ "required": false,
21398
+ "type": "boolean",
21399
+ "example": null
21400
+ },
21401
+ {
21402
+ "name": "disabled",
21403
+ "decorators": [],
21404
+ "description": "Переводит кнопку в состояние \"не активна\"",
21405
+ "required": false,
21406
+ "type": "boolean",
21407
+ "example": "true"
21408
+ },
21409
+ {
21410
+ "name": "formId",
21411
+ "decorators": [],
21412
+ "description": "ID формы, для которой кнопка выполняет submit. При указании ID формы кнопка будет показывать состояние загрузки\nпри отправке формы.",
21413
+ "required": false,
21414
+ "type": "string | boolean",
21415
+ "example": null
21416
+ },
21417
+ {
21418
+ "name": "hint",
21419
+ "decorators": [],
21420
+ "description": "Подсказка, отображается при наведении (через тег title)",
21421
+ "required": false,
21422
+ "type": "any",
21423
+ "example": "Save"
21424
+ },
21425
+ {
21426
+ "name": "icon",
21427
+ "decorators": [],
21428
+ "description": "Иконка",
21429
+ "required": false,
21430
+ "type": "string",
21431
+ "example": null
21432
+ },
21433
+ {
21434
+ "name": "id",
21435
+ "decorators": [],
21436
+ "description": "Идентификатор элемента",
21437
+ "required": false,
21438
+ "type": "string | number",
21439
+ "example": null
21440
+ },
21441
+ {
21442
+ "name": "isFailed",
21443
+ "decorators": [],
21444
+ "description": "Отобразить кнопку в состоянии неуспешного нажатия (например, при неуспешном ajax запросе)",
21445
+ "required": false,
21446
+ "type": "boolean",
21447
+ "example": "true"
21448
+ },
21449
+ {
21450
+ "name": "isLoading",
21451
+ "decorators": [],
21452
+ "description": "Отображать индикатор загрузки?",
21453
+ "required": false,
21454
+ "type": "boolean",
21455
+ "example": "true"
21456
+ },
21457
+ {
21458
+ "name": "itemProps",
21459
+ "decorators": [],
21460
+ "description": "Props для пункта",
21461
+ "required": false,
21462
+ "type": "IButtonProps",
21463
+ "example": null
21464
+ },
21465
+ {
21466
+ "name": "items",
21467
+ "decorators": [],
21468
+ "description": "Вложенные элементы",
21469
+ "required": false,
21470
+ "type": "INavItem[]",
21471
+ "example": null
21472
+ },
21473
+ {
21474
+ "name": "label",
21475
+ "decorators": [],
21476
+ "description": "Текст элемента",
21477
+ "required": false,
21478
+ "type": "any",
21479
+ "example": "'Отзывы'"
21480
+ },
21481
+ {
21482
+ "name": "link",
21483
+ "decorators": [],
21484
+ "description": "Отображать как ссылку?",
21485
+ "required": false,
21486
+ "type": "boolean",
21487
+ "example": "true"
21488
+ },
21489
+ {
21490
+ "name": "onClick",
21491
+ "decorators": [],
21492
+ "description": "Обработчик события нажатия",
21493
+ "required": false,
21494
+ "type": "{}",
21495
+ "example": null
21496
+ },
21497
+ {
21498
+ "name": "outline",
21499
+ "decorators": [],
21500
+ "description": "Включает стиль `outline`, когда у кнопки остается только `border`, а цвет кнопки становится прозрачным",
21501
+ "required": false,
21502
+ "type": "boolean",
21503
+ "example": "true"
21504
+ },
21505
+ {
21506
+ "name": "resetFailedMs",
21507
+ "decorators": [],
21508
+ "description": "Через сколько миллисекунд должно исчезнуть состояние \"failed\"",
21509
+ "required": false,
21510
+ "type": "number",
21511
+ "example": "5000"
21512
+ },
21513
+ {
21514
+ "name": "size",
21515
+ "decorators": [],
21516
+ "description": "Размер",
21517
+ "required": false,
21518
+ "type": "string",
21519
+ "example": null
21520
+ },
21521
+ {
21522
+ "name": "style",
21523
+ "decorators": [],
21524
+ "description": "Объект CSS стилей",
21525
+ "required": false,
21526
+ "type": "CSSProperties",
21527
+ "example": "{width: '45%'}"
21528
+ },
21529
+ {
21530
+ "name": "tag",
21531
+ "decorators": [],
21532
+ "description": "Выбор html-тэга, который будет вставлен в DOM",
21533
+ "required": false,
21534
+ "type": "\"button\" | \"a\"",
21535
+ "example": "button"
21536
+ },
21537
+ {
21538
+ "name": "target",
21539
+ "decorators": [],
21540
+ "description": "HTML аттрибут `target`, доступен только для ссылок",
21541
+ "required": false,
21542
+ "type": "string",
21543
+ "example": "_blank"
21544
+ },
21545
+ {
21546
+ "name": "textColor",
21547
+ "decorators": [],
21548
+ "description": "Цвет текста кнопки или ссылки",
21549
+ "required": false,
21550
+ "type": "any",
21551
+ "example": null
21552
+ },
21553
+ {
21554
+ "name": "toRoute",
21555
+ "decorators": [],
21556
+ "description": "ID роута, на который необходимо перейти, указанный в дереве `steroids` роутинга. Для передачи параметров\nиспользуйте свойство `toRouteParams`",
21557
+ "required": false,
21558
+ "type": "string",
21559
+ "example": "profile"
21560
+ },
21561
+ {
21562
+ "name": "toRouteParams",
21563
+ "decorators": [],
21564
+ "description": "Параметры роута, на который необходимо перейти, см. свойство `toRoute`.",
21565
+ "required": false,
21566
+ "type": "Record",
21567
+ "example": "{userId: 52}"
21568
+ },
21569
+ {
21570
+ "name": "type",
21571
+ "decorators": [],
21572
+ "description": "HTML Тип",
21573
+ "required": false,
21574
+ "type": "\"button\" | \"submit\"",
21575
+ "example": "submit"
21576
+ },
21577
+ {
21578
+ "name": "url",
21579
+ "decorators": [],
21580
+ "description": "Ссылка на внешнюю страницу",
21581
+ "required": false,
21582
+ "type": "string",
21583
+ "example": "https://ya.ru"
21584
+ },
21585
+ {
21586
+ "name": "view",
21587
+ "decorators": [],
21588
+ "description": "Переопределение view React компонента для кастомизации отображения элемента",
21589
+ "required": false,
21590
+ "type": "React.ReactNode | {}",
21591
+ "example": "MyCustomView"
21592
+ },
21593
+ {
21594
+ "name": "visible",
21595
+ "decorators": [],
21596
+ "description": "Видимость элемента",
21597
+ "required": false,
21598
+ "type": "boolean",
21599
+ "example": "true"
21600
+ }
21601
+ ]
21602
+ },
21603
+ "ISidebarProps": {
21604
+ "name": "ISidebarProps",
21605
+ "moduleName": "ui/layout/Sidebar/Sidebar",
21606
+ "title": "",
21607
+ "description": "",
21608
+ "tags": {},
21609
+ "defaultProps": null,
21610
+ "extends": [
21611
+ "IUiComponent"
21612
+ ],
21613
+ "properties": [
21614
+ {
21615
+ "name": "className",
21616
+ "decorators": [],
21617
+ "description": "Дополнительный CSS-класс для элемента отображения",
21618
+ "required": false,
21619
+ "type": "string",
21620
+ "example": null
21621
+ },
21622
+ {
21623
+ "name": "footerIcons",
21624
+ "decorators": [],
21625
+ "description": "Массив объектов с информацией об иконках для футера.",
21626
+ "required": false,
21627
+ "type": "IIconProps[]",
21628
+ "example": null
21629
+ },
21630
+ {
21631
+ "name": "hasSeparatedNavItem",
21632
+ "decorators": [],
21633
+ "description": "Флаг, определяющий, следует ли разделять элементы навигации.",
21634
+ "required": false,
21635
+ "type": "boolean",
21636
+ "example": null
21637
+ },
21638
+ {
21639
+ "name": "isOpenedByDefault",
21640
+ "decorators": [],
21641
+ "description": "Флаг, определяющий, будет ли сайдбар открытым по умолчанию.",
21642
+ "required": false,
21643
+ "type": "boolean",
21644
+ "example": null
21645
+ },
21646
+ {
21647
+ "name": "items",
21648
+ "decorators": [],
21649
+ "description": "Элементы навигации для компонента Nav.",
21650
+ "required": false,
21651
+ "type": "ISidebarItem[]",
21652
+ "example": null
21653
+ },
21654
+ {
21655
+ "name": "logo",
21656
+ "decorators": [],
21657
+ "description": "Объект с информацией о логотипе.",
21658
+ "required": false,
21659
+ "type": "{icon: string | ReactElement, label: string}",
21660
+ "example": null
21661
+ },
21662
+ {
21663
+ "name": "menu",
21664
+ "decorators": [],
21665
+ "description": "Props для компонента Menu.",
21666
+ "required": false,
21667
+ "type": "IMenuProps",
21668
+ "example": null
21669
+ },
21670
+ {
21671
+ "name": "onClickItem",
21672
+ "decorators": [],
21673
+ "description": "Callback-функция, вызывается при клике на элемент навигации.",
21674
+ "required": false,
21675
+ "type": "{}",
21676
+ "example": null
21677
+ },
21678
+ {
21679
+ "name": "onToggleSidebar",
21680
+ "decorators": [],
21681
+ "description": "Callback-функция, вызывается при переключении сайдбара.",
21682
+ "required": false,
21683
+ "type": "{}",
21684
+ "example": null
21685
+ },
21686
+ {
21687
+ "name": "style",
21688
+ "decorators": [],
21689
+ "description": "Объект CSS стилей",
21690
+ "required": false,
21691
+ "type": "CSSProperties",
21692
+ "example": "{width: '45%'}"
21693
+ },
21694
+ {
21695
+ "name": "user",
21696
+ "decorators": [],
21697
+ "description": "Объект с информацией о пользователе.",
21698
+ "required": false,
21699
+ "type": "{name: string, picture: string}",
21700
+ "example": null
21701
+ },
21702
+ {
21703
+ "name": "view",
21704
+ "decorators": [],
21705
+ "description": "Переопределение view React компонента для кастомизации отображения",
21706
+ "required": false,
21707
+ "type": "React.ReactNode | {}",
21708
+ "example": "MyCustomView"
21709
+ }
21710
+ ]
21711
+ },
21712
+ "ISidebarViewProps": {
21713
+ "name": "ISidebarViewProps",
21714
+ "moduleName": "ui/layout/Sidebar/Sidebar",
21715
+ "title": "",
21716
+ "description": "",
21717
+ "tags": {},
21718
+ "defaultProps": null,
21719
+ "extends": [
21720
+ "ISidebarProps"
21721
+ ],
21722
+ "properties": [
21723
+ {
21724
+ "name": "className",
21725
+ "decorators": [],
21726
+ "description": "Дополнительный CSS-класс для элемента отображения",
21727
+ "required": false,
21728
+ "type": "string",
21729
+ "example": null
21730
+ },
21731
+ {
21732
+ "name": "footerIcons",
21733
+ "decorators": [],
21734
+ "description": "Массив объектов с информацией об иконках для футера.",
21735
+ "required": false,
21736
+ "type": "IIconProps[]",
21737
+ "example": null
21738
+ },
21739
+ {
21740
+ "name": "hasSeparatedNavItem",
21741
+ "decorators": [],
21742
+ "description": "Флаг, определяющий, следует ли разделять элементы навигации.",
21743
+ "required": false,
21744
+ "type": "boolean",
21745
+ "example": null
21746
+ },
21747
+ {
21748
+ "name": "isOpened",
21749
+ "decorators": [],
21750
+ "description": "",
21751
+ "required": true,
21752
+ "type": "boolean",
21753
+ "example": null
21754
+ },
21755
+ {
21756
+ "name": "isOpenedByDefault",
21757
+ "decorators": [],
21758
+ "description": "Флаг, определяющий, будет ли сайдбар открытым по умолчанию.",
21759
+ "required": false,
21760
+ "type": "boolean",
21761
+ "example": null
21762
+ },
21763
+ {
21764
+ "name": "items",
21765
+ "decorators": [],
21766
+ "description": "Элементы навигации для компонента Nav.",
21767
+ "required": false,
21768
+ "type": "ISidebarItem[]",
21769
+ "example": null
21770
+ },
21771
+ {
21772
+ "name": "logo",
21773
+ "decorators": [],
21774
+ "description": "Объект с информацией о логотипе.",
21775
+ "required": false,
21776
+ "type": "{icon: string | ReactElement, label: string}",
21777
+ "example": null
21778
+ },
21779
+ {
21780
+ "name": "menu",
21781
+ "decorators": [],
21782
+ "description": "Props для компонента Menu.",
21783
+ "required": false,
21784
+ "type": "IMenuProps",
21785
+ "example": null
21786
+ },
21787
+ {
21788
+ "name": "onClickItem",
21789
+ "decorators": [],
21790
+ "description": "Callback-функция, вызывается при клике на элемент навигации.",
21791
+ "required": false,
21792
+ "type": "{}",
21793
+ "example": null
21794
+ },
21795
+ {
21796
+ "name": "onClickNav",
21797
+ "decorators": [],
21798
+ "description": "",
21799
+ "required": true,
21800
+ "type": "{}",
21801
+ "example": null
21802
+ },
21803
+ {
21804
+ "name": "onToggleSidebar",
21805
+ "decorators": [],
21806
+ "description": "Callback-функция, вызывается при переключении сайдбара.",
21807
+ "required": false,
21808
+ "type": "{}",
21809
+ "example": null
21810
+ },
21811
+ {
21812
+ "name": "style",
21813
+ "decorators": [],
21814
+ "description": "Объект CSS стилей",
21815
+ "required": false,
21816
+ "type": "CSSProperties",
21817
+ "example": "{width: '45%'}"
21818
+ },
21819
+ {
21820
+ "name": "toggleSidebar",
21821
+ "decorators": [],
21822
+ "description": "",
21823
+ "required": true,
21824
+ "type": "VoidFunction",
21825
+ "example": null
21826
+ },
21827
+ {
21828
+ "name": "user",
21829
+ "decorators": [],
21830
+ "description": "Объект с информацией о пользователе.",
21831
+ "required": false,
21832
+ "type": "{name: string, picture: string}",
21833
+ "example": null
21834
+ },
21835
+ {
21836
+ "name": "view",
21837
+ "decorators": [],
21838
+ "description": "Переопределение view React компонента для кастомизации отображения",
21839
+ "required": false,
21840
+ "type": "React.ReactNode | {}",
21841
+ "example": "MyCustomView"
21842
+ }
21843
+ ]
21844
+ },
21845
+ "ISkeletonProps": {
21846
+ "name": "ISkeletonProps",
21847
+ "moduleName": "ui/layout/Skeleton/Skeleton",
21848
+ "title": "Компонент Skeleton представляет собой заглушку для отображения временных данных",
21849
+ "description": "во время загрузки или ожидания загрузки реальных данных.",
21850
+ "tags": {},
21851
+ "defaultProps": null,
21852
+ "extends": [],
21853
+ "properties": [
21854
+ {
21855
+ "name": "animation",
21856
+ "decorators": [],
21857
+ "description": "Тип анимации",
21858
+ "required": false,
21859
+ "type": "\"pulse\" | \"wave\"",
21860
+ "example": null
21861
+ },
21862
+ {
21863
+ "name": "children",
21864
+ "decorators": [],
21865
+ "description": "Дочерние элементы",
21866
+ "required": false,
21867
+ "type": "ReactNode",
21868
+ "example": null
21869
+ },
21870
+ {
21871
+ "name": "className",
21872
+ "decorators": [],
21873
+ "description": "Дополнительные CSS классы",
21874
+ "required": false,
21875
+ "type": "string",
21876
+ "example": "my-block"
21877
+ },
21878
+ {
21879
+ "name": "height",
21880
+ "decorators": [],
21881
+ "description": "Высота элемента",
21882
+ "required": false,
21883
+ "type": "string | number",
21884
+ "example": null
21885
+ },
21886
+ {
21887
+ "name": "type",
21888
+ "decorators": [],
21889
+ "description": "Тип компонента",
21890
+ "required": false,
21891
+ "type": "\"circle\" | \"rect\" | \"text\"",
21892
+ "example": null
21893
+ },
21894
+ {
21895
+ "name": "width",
21896
+ "decorators": [],
21897
+ "description": "Ширина элемента",
21898
+ "required": false,
21899
+ "type": "string | number",
21900
+ "example": null
21901
+ }
21902
+ ]
21903
+ },
21904
+ "ISkeletonViewProps": {
21905
+ "name": "ISkeletonViewProps",
21906
+ "moduleName": "ui/layout/Skeleton/Skeleton",
21907
+ "title": "",
21908
+ "description": "",
21909
+ "tags": {},
21910
+ "defaultProps": null,
21911
+ "extends": [],
21912
+ "properties": [
21913
+ {
21914
+ "name": "animation",
21915
+ "decorators": [],
21916
+ "description": "",
21917
+ "required": false,
21918
+ "type": "\"pulse\" | \"wave\"",
21919
+ "example": null
21920
+ },
21921
+ {
21922
+ "name": "children",
21923
+ "decorators": [],
21924
+ "description": "",
21925
+ "required": false,
21926
+ "type": "ReactNode",
21927
+ "example": null
21928
+ },
21929
+ {
21930
+ "name": "className",
21931
+ "decorators": [],
21932
+ "description": "",
21933
+ "required": false,
21934
+ "type": "string",
21935
+ "example": null
21936
+ },
21937
+ {
21938
+ "name": "height",
21939
+ "decorators": [],
21940
+ "description": "",
21209
21941
  "required": false,
21210
21942
  "type": "string | number",
21211
21943
  "example": null
@@ -24865,7 +25597,7 @@
24865
25597
  {
24866
25598
  "name": "activeButton",
24867
25599
  "decorators": [],
24868
- "description": "Активная кнопка",
25600
+ "description": "При указании в связке с onClick предоставляет возможность реализовать two-way binding",
24869
25601
  "required": false,
24870
25602
  "type": "string | number",
24871
25603
  "example": "'button1'"
@@ -24886,6 +25618,14 @@
24886
25618
  "type": "string",
24887
25619
  "example": null
24888
25620
  },
25621
+ {
25622
+ "name": "defaultActiveButton",
25623
+ "decorators": [],
25624
+ "description": "Кнопка по умолчанию.",
25625
+ "required": false,
25626
+ "type": "string | number",
25627
+ "example": null
25628
+ },
24889
25629
  {
24890
25630
  "name": "items",
24891
25631
  "decorators": [],
@@ -24935,7 +25675,7 @@
24935
25675
  {
24936
25676
  "name": "activeButton",
24937
25677
  "decorators": [],
24938
- "description": "Активная кнопка",
25678
+ "description": "При указании в связке с onClick предоставляет возможность реализовать two-way binding",
24939
25679
  "required": false,
24940
25680
  "type": "string | number",
24941
25681
  "example": "'button1'"
@@ -24956,6 +25696,14 @@
24956
25696
  "type": "string",
24957
25697
  "example": null
24958
25698
  },
25699
+ {
25700
+ "name": "defaultActiveButton",
25701
+ "decorators": [],
25702
+ "description": "Кнопка по умолчанию.",
25703
+ "required": false,
25704
+ "type": "string | number",
25705
+ "example": null
25706
+ },
24959
25707
  {
24960
25708
  "name": "items",
24961
25709
  "decorators": [],
@@ -25723,6 +26471,22 @@
25723
26471
  "type": "boolean",
25724
26472
  "example": "true"
25725
26473
  },
26474
+ {
26475
+ "name": "itemProps",
26476
+ "decorators": [],
26477
+ "description": "Props для пункта",
26478
+ "required": false,
26479
+ "type": "IButtonProps",
26480
+ "example": null
26481
+ },
26482
+ {
26483
+ "name": "items",
26484
+ "decorators": [],
26485
+ "description": "Вложенные элементы",
26486
+ "required": false,
26487
+ "type": "INavItem[]",
26488
+ "example": null
26489
+ },
25726
26490
  {
25727
26491
  "name": "label",
25728
26492
  "decorators": [],
@@ -25878,14 +26642,6 @@
25878
26642
  "type": "string",
25879
26643
  "example": null
25880
26644
  },
25881
- {
25882
- "name": "dark",
25883
- "decorators": [],
25884
- "description": "Темная тема",
25885
- "required": false,
25886
- "type": "boolean",
25887
- "example": null
25888
- },
25889
26645
  {
25890
26646
  "name": "items",
25891
26647
  "decorators": [],
@@ -25955,20 +26711,12 @@
25955
26711
  "type": "string",
25956
26712
  "example": null
25957
26713
  },
25958
- {
25959
- "name": "dark",
25960
- "decorators": [],
25961
- "description": "Темная тема",
25962
- "required": false,
25963
- "type": "boolean",
25964
- "example": null
25965
- },
25966
26714
  {
25967
26715
  "name": "items",
25968
26716
  "decorators": [],
25969
26717
  "description": "Коллекция с элементами навигации. Также можно передать идентификатор роута, тогда компонент найдет все\nвложенные роуты и отобразит их в навигации.",
25970
26718
  "required": true,
25971
- "type": "INavItem & {isActive: boolean}[]",
26719
+ "type": "INavItem & {isActive: boolean, isActiveNested: boolean}[]",
25972
26720
  "example": null
25973
26721
  },
25974
26722
  {
@@ -27020,14 +27768,6 @@
27020
27768
  "type": "IInputFieldProps",
27021
27769
  "example": null
27022
27770
  },
27023
- "IHeaderViewProps": {
27024
- "name": "IHeaderViewProps",
27025
- "decorators": [],
27026
- "description": "",
27027
- "required": true,
27028
- "type": "IHeaderProps",
27029
- "example": null
27030
- },
27031
27771
  "ILoaderViewProps": {
27032
27772
  "name": "ILoaderViewProps",
27033
27773
  "decorators": [],
package/en.json ADDED
@@ -0,0 +1,4 @@
1
+ {
2
+ "Кнопка или ссылка. Используется в интерфейсе для выполнения какого-либо действия по клику (onClick), смена страницы в рамках роутинга (goToRoute), переход по внешней ссылке (url) или отправки формы (submit form)": "Button or link. Used in the interface to perform some action on click (onClick), changing the page within the routing (goToRoute), following an external link (url) or submitting a form (submit form)",
3
+ "Текст кнопки или ссылки": "Text for button or link"
4
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@steroidsjs/core",
3
- "version": "3.0.0-beta.65",
3
+ "version": "3.0.0-beta.67",
4
4
  "description": "",
5
5
  "author": "Vladimir Kozhin <hello@kozhindev.com>",
6
6
  "repository": {
@@ -21,7 +21,7 @@
21
21
  "docs": "node build/docs-autogen.js",
22
22
  "test": "jest",
23
23
  "lint": "eslint -c ./.eslintrc --ext .js,.jsx,.ts,.tsx ./src ./tests --quiet",
24
- "build": "tsc && cp ./{package.json,LICENSE,README.md} dist/ && cp src/index.d.ts dist/ && cp build/docs-autogen-result.json dist/",
24
+ "build": "tsc && cp ./{package.json,LICENSE,README.md} dist/ && cp src/index.d.ts dist/ && cp build/docs-autogen-result.json dist/ && cp build/locale/en.json dist/",
25
25
  "watch": "tsc -p tsconfig-debug.json"
26
26
  },
27
27
  "dependencies": {