@iress-oss/ids-mcp-server 5.20.1 → 5.20.4
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/generated/docs/components_components-alert-docs.md +22 -21
- package/generated/docs/components_components-autocomplete-docs.md +48 -104
- package/generated/docs/components_components-autocomplete-recipes-docs.md +9 -2
- package/generated/docs/components_components-badge-docs.md +4 -4
- package/generated/docs/components_components-button-docs.md +24 -24
- package/generated/docs/components_components-buttongroup-docs.md +20 -20
- package/generated/docs/components_components-card-docs.md +70 -56
- package/generated/docs/components_components-card-recipes-docs.md +4 -4
- package/generated/docs/components_components-checkbox-docs.md +7 -21
- package/generated/docs/components_components-checkboxgroup-docs.md +32 -32
- package/generated/docs/components_components-checkboxgroup-recipes-docs.md +2 -2
- package/generated/docs/components_components-col-docs.md +10 -10
- package/generated/docs/components_components-combobox-docs.md +58 -90
- package/generated/docs/components_components-container-docs.md +4 -4
- package/generated/docs/components_components-divider-docs.md +3 -3
- package/generated/docs/components_components-expander-docs.md +6 -4
- package/generated/docs/components_components-field-docs.md +18 -18
- package/generated/docs/components_components-filter-docs.md +54 -54
- package/generated/docs/components_components-form-docs.md +95 -60
- package/generated/docs/components_components-form-recipes-docs.md +114 -13
- package/generated/docs/components_components-hide-docs.md +4 -4
- package/generated/docs/components_components-icon-docs.md +13 -13
- package/generated/docs/components_components-inline-docs.md +14 -14
- package/generated/docs/components_components-input-docs.md +10 -10
- package/generated/docs/components_components-input-recipes-docs.md +3 -3
- package/generated/docs/components_components-inputcurrency-docs.md +6 -6
- package/generated/docs/components_components-inputcurrency-recipes-docs.md +5 -2
- package/generated/docs/components_components-label-docs.md +6 -6
- package/generated/docs/components_components-menu-docs.md +40 -40
- package/generated/docs/components_components-menu-menuitem-docs.md +12 -12
- package/generated/docs/components_components-modal-docs.md +29 -13
- package/generated/docs/components_components-navbar-docs.md +42 -42
- package/generated/docs/components_components-navbar-recipes-docs.md +41 -18
- package/generated/docs/components_components-panel-docs.md +19 -19
- package/generated/docs/components_components-placeholder-docs.md +1 -1
- package/generated/docs/components_components-popover-docs.md +32 -30
- package/generated/docs/components_components-popover-recipes-docs.md +15 -8
- package/generated/docs/components_components-progress-docs.md +1 -1
- package/generated/docs/components_components-provider-docs.md +2 -2
- package/generated/docs/components_components-radio-docs.md +5 -5
- package/generated/docs/components_components-radiogroup-docs.md +29 -45
- package/generated/docs/components_components-readonly-docs.md +5 -5
- package/generated/docs/components_components-richselect-docs.md +88 -64
- package/generated/docs/components_components-row-docs.md +12 -12
- package/generated/docs/components_components-select-docs.md +8 -8
- package/generated/docs/components_components-skeleton-docs.md +9 -9
- package/generated/docs/components_components-skeleton-recipes-docs.md +2 -2
- package/generated/docs/components_components-skiplink-docs.md +3 -3
- package/generated/docs/components_components-slideout-docs.md +43 -12
- package/generated/docs/components_components-slider-docs.md +12 -12
- package/generated/docs/components_components-spinner-docs.md +3 -3
- package/generated/docs/components_components-stack-docs.md +14 -14
- package/generated/docs/components_components-table-docs.md +51 -44
- package/generated/docs/components_components-tabset-docs.md +10 -10
- package/generated/docs/components_components-tabset-tab-docs.md +4 -4
- package/generated/docs/components_components-tag-docs.md +8 -10
- package/generated/docs/components_components-text-docs.md +7 -7
- package/generated/docs/components_components-toaster-docs.md +12 -12
- package/generated/docs/components_components-toaster-toast-docs.md +30 -30
- package/generated/docs/components_components-toggle-docs.md +5 -5
- package/generated/docs/components_components-tooltip-docs.md +4 -4
- package/generated/docs/components_components-validationmessage-docs.md +6 -6
- package/generated/docs/components_foundations-colour-030-colours.md +32 -32
- package/generated/docs/components_foundations-typography-docs.md +7 -7
- package/generated/docs/components_introduction-docs.md +1 -1
- package/generated/docs/components_patterns-loading-docs.md +106 -29
- package/generated/docs/components_sandbox-docs.md +4 -0
- package/generated/docs/guidelines.md +39 -39
- package/package.json +20 -20
|
@@ -17,7 +17,7 @@ Menu item (button)
|
|
|
17
17
|
|
|
18
18
|
[Menu item (link)](https://iress.com)Menu item (selected)
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Hide codedrawOpen in CodeSandbox
|
|
21
21
|
|
|
22
22
|
<IressMenu defaultSelected\="5"\>
|
|
23
23
|
<IressMenuHeading\>
|
|
@@ -59,7 +59,7 @@ ReactReactNode
|
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
|
|
62
|
-
| \- |
|
|
62
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
63
63
|
| defaultSelected |
|
|
64
64
|
|
|
65
65
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -153,7 +153,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
153
153
|
|
|
154
154
|
MenuType
|
|
155
155
|
|
|
156
|
-
<table class="css-
|
|
156
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
157
157
|
|
|
158
158
|
| \- | Set object |
|
|
159
159
|
|
|
@@ -181,7 +181,7 @@ Menu item (button)
|
|
|
181
181
|
|
|
182
182
|
[Menu item (link)](https://iress.com)Menu item (selected)
|
|
183
183
|
|
|
184
|
-
|
|
184
|
+
Hide codedrawOpen in CodeSandbox
|
|
185
185
|
|
|
186
186
|
<IressMenu defaultSelected\="5"\>
|
|
187
187
|
<IressMenuHeading\>
|
|
@@ -220,7 +220,7 @@ ReactReactNode
|
|
|
220
220
|
|
|
221
221
|
|
|
222
222
|
|
|
223
|
-
| \- |
|
|
223
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
224
224
|
| defaultSelected |
|
|
225
225
|
|
|
226
226
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -314,7 +314,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
314
314
|
|
|
315
315
|
MenuType
|
|
316
316
|
|
|
317
|
-
<table class="css-
|
|
317
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
318
318
|
|
|
319
319
|
| \- | Set object |
|
|
320
320
|
|
|
@@ -337,7 +337,7 @@ Button with append and prepend
|
|
|
337
337
|
|
|
338
338
|
Button with append[A link with a very long name that wraps based on the menu's `noWrap` prop](https://iress.com)
|
|
339
339
|
|
|
340
|
-
|
|
340
|
+
Hide codedrawOpen in CodeSandbox
|
|
341
341
|
|
|
342
342
|
<IressMenu\>
|
|
343
343
|
<IressMenuHeading prepend\={<IressIcon fixedWidth name\="smile"/>}\>
|
|
@@ -401,7 +401,7 @@ ReactReactNode
|
|
|
401
401
|
|
|
402
402
|
|
|
403
403
|
|
|
404
|
-
| \- |
|
|
404
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
405
405
|
| defaultSelected |
|
|
406
406
|
|
|
407
407
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -491,7 +491,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
491
491
|
|
|
492
492
|
MenuType
|
|
493
493
|
|
|
494
|
-
<table class="css-
|
|
494
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
495
495
|
|
|
496
496
|
| \- | Set object |
|
|
497
497
|
|
|
@@ -508,7 +508,7 @@ When rendering a set of links for navigation purposes (as a secondary nav in thi
|
|
|
508
508
|
|
|
509
509
|
[Financial advice](https://www.iress.com/software/financial-advice/)[Trading and market data](https://www.iress.com/software/trading-and-market-data/)[Investment management](https://www.iress.com/software/investment-management/)[Mortgages](https://www.iress.com/software/mortgages/)[Life and pensions](https://www.iress.com/software/life-and-pensions/)
|
|
510
510
|
|
|
511
|
-
|
|
511
|
+
Hide codedrawOpen in CodeSandbox
|
|
512
512
|
|
|
513
513
|
<nav aria-label\="Secondary"\>
|
|
514
514
|
<IressMenu\>
|
|
@@ -550,7 +550,7 @@ ReactReactNode
|
|
|
550
550
|
|
|
551
551
|
|
|
552
552
|
|
|
553
|
-
| \- |
|
|
553
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
554
554
|
| defaultSelected |
|
|
555
555
|
|
|
556
556
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -640,7 +640,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
640
640
|
|
|
641
641
|
MenuType
|
|
642
642
|
|
|
643
|
-
<table class="css-
|
|
643
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
644
644
|
|
|
645
645
|
| \- | Set object |
|
|
646
646
|
|
|
@@ -658,7 +658,7 @@ Menu item 1
|
|
|
658
658
|
|
|
659
659
|
Menu item 2
|
|
660
660
|
|
|
661
|
-
|
|
661
|
+
Hide codedrawOpen in CodeSandbox
|
|
662
662
|
|
|
663
663
|
<IressMenu\>
|
|
664
664
|
<IressMenuHeading level\="h4"\>
|
|
@@ -693,7 +693,7 @@ ReactReactNode
|
|
|
693
693
|
|
|
694
694
|
|
|
695
695
|
|
|
696
|
-
| \- |
|
|
696
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
697
697
|
| defaultSelected |
|
|
698
698
|
|
|
699
699
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -783,7 +783,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
783
783
|
|
|
784
784
|
MenuType
|
|
785
785
|
|
|
786
|
-
<table class="css-
|
|
786
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
787
787
|
|
|
788
788
|
| \- | Set object |
|
|
789
789
|
|
|
@@ -807,7 +807,7 @@ Menu item 3Menu item 4
|
|
|
807
807
|
|
|
808
808
|
Menu item 5
|
|
809
809
|
|
|
810
|
-
|
|
810
|
+
Hide codedrawOpen in CodeSandbox
|
|
811
811
|
|
|
812
812
|
<IressMenu\>
|
|
813
813
|
<IressMenuHeading
|
|
@@ -852,7 +852,7 @@ ReactReactNode
|
|
|
852
852
|
|
|
853
853
|
|
|
854
854
|
|
|
855
|
-
| \- |
|
|
855
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
856
856
|
| defaultSelected |
|
|
857
857
|
|
|
858
858
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -942,7 +942,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
942
942
|
|
|
943
943
|
MenuType
|
|
944
944
|
|
|
945
|
-
<table class="css-
|
|
945
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
946
946
|
|
|
947
947
|
| \- | Set object |
|
|
948
948
|
|
|
@@ -961,7 +961,7 @@ Menu item (button)
|
|
|
961
961
|
|
|
962
962
|
[Menu item (link)](https://iress.com)Menu item (selected)
|
|
963
963
|
|
|
964
|
-
|
|
964
|
+
Hide codedrawOpen in CodeSandbox
|
|
965
965
|
|
|
966
966
|
<IressMenu
|
|
967
967
|
defaultSelected\="5"
|
|
@@ -1003,7 +1003,7 @@ ReactReactNode
|
|
|
1003
1003
|
|
|
1004
1004
|
|
|
1005
1005
|
|
|
1006
|
-
| \- |
|
|
1006
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
1007
1007
|
| defaultSelected |
|
|
1008
1008
|
|
|
1009
1009
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -1097,7 +1097,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
1097
1097
|
|
|
1098
1098
|
MenuType
|
|
1099
1099
|
|
|
1100
|
-
<table class="css-
|
|
1100
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
1101
1101
|
|
|
1102
1102
|
| \- | Set object |
|
|
1103
1103
|
|
|
@@ -1144,7 +1144,7 @@ Menu item (button)
|
|
|
1144
1144
|
|
|
1145
1145
|
[Menu item (link)](https://iress.com)Menu item (selected)
|
|
1146
1146
|
|
|
1147
|
-
|
|
1147
|
+
Hide codedrawOpen in CodeSandbox
|
|
1148
1148
|
|
|
1149
1149
|
<IressStack gutter\="lg"\>
|
|
1150
1150
|
<IressText\>
|
|
@@ -1328,7 +1328,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
1328
1328
|
|
|
1329
1329
|
MenuType
|
|
1330
1330
|
|
|
1331
|
-
<table class="css-
|
|
1331
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
1332
1332
|
|
|
1333
1333
|
| \- | Set object |
|
|
1334
1334
|
|
|
@@ -1342,7 +1342,7 @@ Menu item with some text that wraps
|
|
|
1342
1342
|
|
|
1343
1343
|
Non wrapping menu item with some text
|
|
1344
1344
|
|
|
1345
|
-
|
|
1345
|
+
Hide codedrawOpen in CodeSandbox
|
|
1346
1346
|
|
|
1347
1347
|
<div
|
|
1348
1348
|
style\={{
|
|
@@ -1479,7 +1479,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
1479
1479
|
|
|
1480
1480
|
MenuType
|
|
1481
1481
|
|
|
1482
|
-
<table class="css-
|
|
1482
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
1483
1483
|
|
|
1484
1484
|
| \- | Set object |
|
|
1485
1485
|
|
|
@@ -1498,7 +1498,7 @@ New fileSave file as
|
|
|
1498
1498
|
|
|
1499
1499
|
[Visit the Iress website](https://www.iress.com)[Visit Google8+](https://google.com)
|
|
1500
1500
|
|
|
1501
|
-
|
|
1501
|
+
Hide codedrawOpen in CodeSandbox
|
|
1502
1502
|
|
|
1503
1503
|
<IressMenu role\="menu"\>
|
|
1504
1504
|
<IressMenuHeading prepend\={<IressIcon name\="cog" />}\>
|
|
@@ -1553,7 +1553,7 @@ ReactReactNode
|
|
|
1553
1553
|
|
|
1554
1554
|
|
|
1555
1555
|
|
|
1556
|
-
| \- |
|
|
1556
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
1557
1557
|
| defaultSelected |
|
|
1558
1558
|
|
|
1559
1559
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -1647,7 +1647,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
1647
1647
|
|
|
1648
1648
|
MenuType
|
|
1649
1649
|
|
|
1650
|
-
<table class="css-
|
|
1650
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
1651
1651
|
|
|
1652
1652
|
| \- | Set object |
|
|
1653
1653
|
|
|
@@ -1686,7 +1686,7 @@ Keyboard interaction
|
|
|
1686
1686
|
* Menu items cannot be navigated using the arrow keys
|
|
1687
1687
|
* Menu items are navigated using the `tab` key
|
|
1688
1688
|
|
|
1689
|
-
|
|
1689
|
+
Hide codedrawOpen in CodeSandbox
|
|
1690
1690
|
|
|
1691
1691
|
<IressMenu defaultSelected\={5}\>
|
|
1692
1692
|
<IressMenuHeading\>
|
|
@@ -1725,7 +1725,7 @@ ReactReactNode
|
|
|
1725
1725
|
|
|
1726
1726
|
|
|
1727
1727
|
|
|
1728
|
-
| \- |
|
|
1728
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
1729
1729
|
| defaultSelected |
|
|
1730
1730
|
|
|
1731
1731
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -1819,7 +1819,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
1819
1819
|
|
|
1820
1820
|
MenuType
|
|
1821
1821
|
|
|
1822
|
-
<table class="css-
|
|
1822
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
1823
1823
|
|
|
1824
1824
|
| \- | Set object |
|
|
1825
1825
|
|
|
@@ -1848,7 +1848,7 @@ Keyboard interaction
|
|
|
1848
1848
|
* In inline layouts, pressing the `right` arrow key on the last item will focus the first item
|
|
1849
1849
|
* Pressing the `tab` key when focused on any item in the menu will focus to next focusable item outside of the menu
|
|
1850
1850
|
|
|
1851
|
-
|
|
1851
|
+
Hide codedrawOpen in CodeSandbox
|
|
1852
1852
|
|
|
1853
1853
|
<IressMenu
|
|
1854
1854
|
defaultSelected\={5}
|
|
@@ -1890,7 +1890,7 @@ ReactReactNode
|
|
|
1890
1890
|
|
|
1891
1891
|
|
|
1892
1892
|
|
|
1893
|
-
| \- |
|
|
1893
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
1894
1894
|
| defaultSelected |
|
|
1895
1895
|
|
|
1896
1896
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -1988,7 +1988,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
1988
1988
|
|
|
1989
1989
|
MenuType
|
|
1990
1990
|
|
|
1991
|
-
<table class="css-
|
|
1991
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
1992
1992
|
|
|
1993
1993
|
| \- | Set object |
|
|
1994
1994
|
|
|
@@ -2023,7 +2023,7 @@ Keyboard interaction
|
|
|
2023
2023
|
* In inline layouts, pressing the `left` arrow key on the first item will **not** focus the last item
|
|
2024
2024
|
* Pressing the `tab` key when focused on any item in the menu will focus to next focusable item outside of the menu
|
|
2025
2025
|
|
|
2026
|
-
|
|
2026
|
+
Hide codedrawOpen in CodeSandbox
|
|
2027
2027
|
|
|
2028
2028
|
<IressMenu
|
|
2029
2029
|
aria-label\="Selectable listbox"
|
|
@@ -2069,7 +2069,7 @@ ReactReactNode
|
|
|
2069
2069
|
|
|
2070
2070
|
|
|
2071
2071
|
|
|
2072
|
-
| \- |
|
|
2072
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
2073
2073
|
| defaultSelected |
|
|
2074
2074
|
|
|
2075
2075
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -2167,7 +2167,7 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
2167
2167
|
|
|
2168
2168
|
MenuType
|
|
2169
2169
|
|
|
2170
|
-
<table class="css-
|
|
2170
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
2171
2171
|
|
|
2172
2172
|
| \- | Set object |
|
|
2173
2173
|
|
|
@@ -2200,7 +2200,7 @@ Keyboard interaction
|
|
|
2200
2200
|
* Menu items cannot be navigated using the arrow keys
|
|
2201
2201
|
* Menu items are navigated using the `tab` key
|
|
2202
2202
|
|
|
2203
|
-
|
|
2203
|
+
Hide codedrawOpen in CodeSandbox
|
|
2204
2204
|
|
|
2205
2205
|
<IressMenu
|
|
2206
2206
|
defaultSelected\={5}
|
|
@@ -2242,7 +2242,7 @@ ReactReactNode
|
|
|
2242
2242
|
|
|
2243
2243
|
|
|
2244
2244
|
|
|
2245
|
-
| \- |
|
|
2245
|
+
| \- | childrenChoose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
2246
2246
|
| defaultSelected |
|
|
2247
2247
|
|
|
2248
2248
|
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
@@ -2340,6 +2340,6 @@ Type of Menu - will be set automatically when used inside popover or when the mu
|
|
|
2340
2340
|
|
|
2341
2341
|
MenuType
|
|
2342
2342
|
|
|
2343
|
-
<table class="css-
|
|
2343
|
+
<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `role` instead.</td></tr></tbody></table>
|
|
2344
2344
|
|
|
2345
2345
|
| \- | Set object |
|
|
@@ -10,7 +10,7 @@ Menu items are headings, buttons and dividers used inside an \`IressMenu\`
|
|
|
10
10
|
|
|
11
11
|
Menu item
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Hide codedrawOpen in CodeSandbox
|
|
14
14
|
|
|
15
15
|
<IressMenuItem\>
|
|
16
16
|
Menu item
|
|
@@ -70,7 +70,7 @@ The `IressMenuItem` can be set to selected using the `selected` prop.
|
|
|
70
70
|
|
|
71
71
|
Menu item
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
Hide codedrawOpen in CodeSandbox
|
|
74
74
|
|
|
75
75
|
<IressMenuItem selected\>
|
|
76
76
|
Menu item
|
|
@@ -131,7 +131,7 @@ A menu item can have a unique value set to it, used to determine its selected st
|
|
|
131
131
|
|
|
132
132
|
Menu item with value
|
|
133
133
|
|
|
134
|
-
|
|
134
|
+
Hide codedrawOpen in CodeSandbox
|
|
135
135
|
|
|
136
136
|
<IressMenu role\="listbox"\>
|
|
137
137
|
<IressMenuItem value\={9}\>
|
|
@@ -193,7 +193,7 @@ When `canToggle` is set to true, the menu item can be toggled between selected a
|
|
|
193
193
|
|
|
194
194
|
Menu item with value
|
|
195
195
|
|
|
196
|
-
|
|
196
|
+
Hide codedrawOpen in CodeSandbox
|
|
197
197
|
|
|
198
198
|
<IressMenu role\="listbox"\>
|
|
199
199
|
<IressMenuItem
|
|
@@ -265,7 +265,7 @@ You can prepend and append content to a menu item using the `prepend` and `appen
|
|
|
265
265
|
|
|
266
266
|
Menu itemNew
|
|
267
267
|
|
|
268
|
-
|
|
268
|
+
Hide codedrawOpen in CodeSandbox
|
|
269
269
|
|
|
270
270
|
<IressMenuItem
|
|
271
271
|
append\={<IressBadge mode\="success"\>New</IressBadge\>}
|
|
@@ -289,7 +289,7 @@ ReactReactNode
|
|
|
289
289
|
|
|
290
290
|
| \- |
|
|
291
291
|
|
|
292
|
-
|
|
292
|
+
Edit JSON
|
|
293
293
|
|
|
294
294
|
append :
|
|
295
295
|
|
|
@@ -343,7 +343,7 @@ ReactReactNode
|
|
|
343
343
|
|
|
344
344
|
| \- |
|
|
345
345
|
|
|
346
|
-
|
|
346
|
+
Edit JSON
|
|
347
347
|
|
|
348
348
|
prepend :
|
|
349
349
|
|
|
@@ -383,7 +383,7 @@ Inside a `IressMenu` with a `role` of `listbox` and the `multiSelect` prop set t
|
|
|
383
383
|
|
|
384
384
|
Menu item with valueMenu item with value
|
|
385
385
|
|
|
386
|
-
|
|
386
|
+
Hide codedrawOpen in CodeSandbox
|
|
387
387
|
|
|
388
388
|
<IressMenu
|
|
389
389
|
multiSelect
|
|
@@ -450,7 +450,7 @@ When `divider` is set to true, the menu item will render with a bottom border.
|
|
|
450
450
|
|
|
451
451
|
Menu item with divider
|
|
452
452
|
|
|
453
|
-
|
|
453
|
+
Hide codedrawOpen in CodeSandbox
|
|
454
454
|
|
|
455
455
|
<IressMenuItem divider\>
|
|
456
456
|
Menu item with divider
|
|
@@ -502,7 +502,7 @@ However, it is recommended to use the `IressMenuDivider` component instead.
|
|
|
502
502
|
|
|
503
503
|
* * *
|
|
504
504
|
|
|
505
|
-
|
|
505
|
+
Hide codedrawOpen in CodeSandbox
|
|
506
506
|
|
|
507
507
|
<IressMenuDivider />
|
|
508
508
|
|
|
@@ -519,7 +519,7 @@ You can use the `IressMenuHeading` to render a heading within a menu. By default
|
|
|
519
519
|
Menu heading
|
|
520
520
|
------------
|
|
521
521
|
|
|
522
|
-
|
|
522
|
+
Hide codedrawOpen in CodeSandbox
|
|
523
523
|
|
|
524
524
|
<IressMenuHeading\>
|
|
525
525
|
Menu heading
|
|
@@ -586,7 +586,7 @@ You can use the `IressMenuText` to render text within a menu. This adds styling
|
|
|
586
586
|
|
|
587
587
|
Menu text
|
|
588
588
|
|
|
589
|
-
|
|
589
|
+
Hide codedrawOpen in CodeSandbox
|
|
590
590
|
|
|
591
591
|
<IressMenuText\>
|
|
592
592
|
Menu text
|
|
@@ -25,7 +25,7 @@ Read more
|
|
|
25
25
|
|
|
26
26
|
Show modal
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Hide codedrawOpen in CodeSandbox
|
|
29
29
|
|
|
30
30
|
const Story \= () \=> {
|
|
31
31
|
const { showModal } \= useModal();
|
|
@@ -253,9 +253,9 @@ You can use state to control the modal by setting the `show` property to `true`
|
|
|
253
253
|
|
|
254
254
|
Show modal using state
|
|
255
255
|
|
|
256
|
-
|
|
256
|
+
Hide codedrawOpen in CodeSandbox
|
|
257
257
|
|
|
258
|
-
import { IressButton, IressModal, type IressModalProps } from '
|
|
258
|
+
import { IressButton, IressModal, type IressModalProps } from '@/main';
|
|
259
259
|
import { useState } from 'react';
|
|
260
260
|
export const ModalUsingState \= () \=> {
|
|
261
261
|
const \[show, setShow\] \= useState(false);
|
|
@@ -461,7 +461,7 @@ To use, wrap your `<App/>` or the component that you want to use the `useModal`
|
|
|
461
461
|
|
|
462
462
|
Show modal using provider
|
|
463
463
|
|
|
464
|
-
|
|
464
|
+
Hide codedrawOpen in CodeSandbox
|
|
465
465
|
|
|
466
466
|
import {
|
|
467
467
|
IressButton,
|
|
@@ -469,7 +469,7 @@ import {
|
|
|
469
469
|
type IressModalProps,
|
|
470
470
|
IressModalProvider,
|
|
471
471
|
useModal,
|
|
472
|
-
} from '
|
|
472
|
+
} from '@/main';
|
|
473
473
|
const MODAL\_ID \= 'storybook-modal';
|
|
474
474
|
export const App \= (modalProps: IressModalProps) \=> (
|
|
475
475
|
<IressModalProvider\>
|
|
@@ -540,7 +540,7 @@ Content to appear underneath the main content. Usually used for extra controls l
|
|
|
540
540
|
|
|
541
541
|
Footer slot modal
|
|
542
542
|
|
|
543
|
-
|
|
543
|
+
Hide codedrawOpen in CodeSandbox
|
|
544
544
|
|
|
545
545
|
const Story \= () \=> {
|
|
546
546
|
const { showModal } \= useModal();
|
|
@@ -767,7 +767,7 @@ The fixed footer variant of IressModal prevents content from overflowing the mod
|
|
|
767
767
|
|
|
768
768
|
Fixed footer modal
|
|
769
769
|
|
|
770
|
-
|
|
770
|
+
Hide codedrawOpen in CodeSandbox
|
|
771
771
|
|
|
772
772
|
const Story \= () \=> {
|
|
773
773
|
const { showModal } \= useModal();
|
|
@@ -1012,8 +1012,16 @@ The `size` prop can be set to `sm`, `md`, `lg` or `fullpage`. It defaults to `md
|
|
|
1012
1012
|
|
|
1013
1013
|
smmdlgfullpage
|
|
1014
1014
|
|
|
1015
|
-
|
|
1015
|
+
Hide codedrawOpen in CodeSandbox
|
|
1016
1016
|
|
|
1017
|
+
import {
|
|
1018
|
+
IressButton,
|
|
1019
|
+
IressInline,
|
|
1020
|
+
IressModal,
|
|
1021
|
+
IressModalProvider,
|
|
1022
|
+
MODAL\_SIZES,
|
|
1023
|
+
useModal,
|
|
1024
|
+
} from '@/main';
|
|
1017
1025
|
const ModalWithTrigger \= () \=> {
|
|
1018
1026
|
const { showModal } \= useModal();
|
|
1019
1027
|
return (
|
|
@@ -1236,7 +1244,7 @@ You can override this behaviour by specifying a value for `xs` in your size obje
|
|
|
1236
1244
|
|
|
1237
1245
|
Responsive modal
|
|
1238
1246
|
|
|
1239
|
-
|
|
1247
|
+
Hide codedrawOpen in CodeSandbox
|
|
1240
1248
|
|
|
1241
1249
|
const Story \= () \=> {
|
|
1242
1250
|
const { showModal } \= useModal();
|
|
@@ -1258,7 +1266,7 @@ return (
|
|
|
1258
1266
|
xl: 'lg'
|
|
1259
1267
|
}}
|
|
1260
1268
|
\>
|
|
1261
|
-
<
|
|
1269
|
+
<Ln />
|
|
1262
1270
|
</IressModal\>
|
|
1263
1271
|
</\>
|
|
1264
1272
|
);
|
|
@@ -1445,7 +1453,7 @@ union
|
|
|
1445
1453
|
|
|
1446
1454
|
|
|
|
1447
1455
|
|
|
1448
|
-
|
|
1456
|
+
Edit JSON
|
|
1449
1457
|
|
|
1450
1458
|
size :
|
|
1451
1459
|
|
|
@@ -1482,8 +1490,16 @@ The `padding` prop can be set to either `none`, `sm`, `md` or `lg`. It defaults
|
|
|
1482
1490
|
|
|
1483
1491
|
none paddingsm paddingmd paddinglg padding
|
|
1484
1492
|
|
|
1485
|
-
|
|
1493
|
+
Hide codedrawOpen in CodeSandbox
|
|
1486
1494
|
|
|
1495
|
+
import {
|
|
1496
|
+
IressButton,
|
|
1497
|
+
IressInline,
|
|
1498
|
+
IressModal,
|
|
1499
|
+
IressModalProvider,
|
|
1500
|
+
PADDING\_SIZES,
|
|
1501
|
+
useModal,
|
|
1502
|
+
} from '@/main';
|
|
1487
1503
|
const ModalWithTrigger \= () \=> {
|
|
1488
1504
|
const { showModal } \= useModal();
|
|
1489
1505
|
return (
|
|
@@ -1691,7 +1707,7 @@ For instances where you require the user's full attention and you want to ensure
|
|
|
1691
1707
|
|
|
1692
1708
|
Disable backdrop clickNo close button (please provide one, if you decide to hide the close button)Both (If you hide the close button, ensure you provide another way to close the modal)
|
|
1693
1709
|
|
|
1694
|
-
|
|
1710
|
+
Hide codedrawOpen in CodeSandbox
|
|
1695
1711
|
|
|
1696
1712
|
const Story \= () \=> {
|
|
1697
1713
|
const { showModal } \= useModal();
|