@iress-oss/ids-mcp-server 5.14.2 → 5.20.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/generated/docs/components_components-alert-docs.md +492 -0
  2. package/generated/docs/components_components-autocomplete-docs.md +3485 -0
  3. package/generated/docs/{components-autocomplete-recipes-docs.md → components_components-autocomplete-recipes-docs.md} +32 -14
  4. package/generated/docs/{components-badge-docs.md → components_components-badge-docs.md} +222 -30
  5. package/generated/docs/components_components-button-docs.md +2078 -0
  6. package/generated/docs/components_components-button-recipes-docs.md +37 -0
  7. package/generated/docs/components_components-buttongroup-docs.md +1045 -0
  8. package/generated/docs/components_components-card-docs.md +2276 -0
  9. package/generated/docs/{components-card-recipes-docs.md → components_components-card-recipes-docs.md} +131 -14
  10. package/generated/docs/components_components-checkbox-docs.md +1054 -0
  11. package/generated/docs/{components-checkboxgroup-docs.md → components_components-checkboxgroup-docs.md} +1000 -81
  12. package/generated/docs/{components-checkboxgroup-recipes-docs.md → components_components-checkboxgroup-recipes-docs.md} +101 -11
  13. package/generated/docs/{components-col-docs.md → components_components-col-docs.md} +331 -58
  14. package/generated/docs/components_components-combobox-docs.md +3767 -0
  15. package/generated/docs/{components-container-docs.md → components_components-container-docs.md} +61 -24
  16. package/generated/docs/{components-divider-docs.md → components_components-divider-docs.md} +83 -24
  17. package/generated/docs/{components-expander-docs.md → components_components-expander-docs.md} +264 -33
  18. package/generated/docs/{components-field-docs.md → components_components-field-docs.md} +814 -120
  19. package/generated/docs/components_components-filter-docs.md +4080 -0
  20. package/generated/docs/{components-form-docs.md → components_components-form-docs.md} +1488 -358
  21. package/generated/docs/{components-form-recipes-docs.md → components_components-form-recipes-docs.md} +174 -64
  22. package/generated/docs/components_components-hide-docs.md +293 -0
  23. package/generated/docs/components_components-icon-docs.md +1337 -0
  24. package/generated/docs/{components-inline-docs.md → components_components-inline-docs.md} +462 -42
  25. package/generated/docs/components_components-input-docs.md +1468 -0
  26. package/generated/docs/components_components-input-recipes-docs.md +367 -0
  27. package/generated/docs/components_components-inputcurrency-docs.md +432 -0
  28. package/generated/docs/{components-inputcurrency-recipes-docs.md → components_components-inputcurrency-recipes-docs.md} +110 -17
  29. package/generated/docs/components_components-label-docs.md +323 -0
  30. package/generated/docs/components_components-menu-docs.md +2345 -0
  31. package/generated/docs/components_components-menu-menuitem-docs.md +633 -0
  32. package/generated/docs/{components-modal-docs.md → components_components-modal-docs.md} +1625 -232
  33. package/generated/docs/components_components-navbar-docs.md +1847 -0
  34. package/generated/docs/{components-navbar-recipes-docs.md → components_components-navbar-recipes-docs.md} +697 -39
  35. package/generated/docs/{components-panel-docs.md → components_components-panel-docs.md} +754 -57
  36. package/generated/docs/components_components-placeholder-docs.md +92 -0
  37. package/generated/docs/components_components-popover-docs.md +1641 -0
  38. package/generated/docs/{components-popover-recipes-docs.md → components_components-popover-recipes-docs.md} +347 -17
  39. package/generated/docs/components_components-progress-docs.md +115 -0
  40. package/generated/docs/components_components-provider-docs.md +114 -0
  41. package/generated/docs/components_components-radio-docs.md +491 -0
  42. package/generated/docs/{components-radiogroup-docs.md → components_components-radiogroup-docs.md} +943 -75
  43. package/generated/docs/components_components-readonly-docs.md +263 -0
  44. package/generated/docs/components_components-richselect-docs.md +6497 -0
  45. package/generated/docs/{components-row-docs.md → components_components-row-docs.md} +353 -43
  46. package/generated/docs/{components-select-docs.md → components_components-select-docs.md} +719 -61
  47. package/generated/docs/components_components-skeleton-docs.md +480 -0
  48. package/generated/docs/{components-skeleton-recipes-docs.md → components_components-skeleton-recipes-docs.md} +50 -10
  49. package/generated/docs/{components-skiplink-docs.md → components_components-skiplink-docs.md} +53 -14
  50. package/generated/docs/components_components-slideout-docs.md +2262 -0
  51. package/generated/docs/components_components-slider-docs.md +1276 -0
  52. package/generated/docs/components_components-spinner-docs.md +82 -0
  53. package/generated/docs/{components-stack-docs.md → components_components-stack-docs.md} +223 -40
  54. package/generated/docs/components_components-table-docs.md +3651 -0
  55. package/generated/docs/components_components-tabset-docs.md +772 -0
  56. package/generated/docs/components_components-tabset-tab-docs.md +262 -0
  57. package/generated/docs/components_components-tag-docs.md +259 -0
  58. package/generated/docs/{components-text-docs.md → components_components-text-docs.md} +491 -51
  59. package/generated/docs/{components-toaster-docs.md → components_components-toaster-docs.md} +224 -71
  60. package/generated/docs/components_components-toaster-toast-docs.md +634 -0
  61. package/generated/docs/components_components-toggle-docs.md +461 -0
  62. package/generated/docs/{components-tooltip-docs.md → components_components-tooltip-docs.md} +286 -41
  63. package/generated/docs/{components-validationmessage-docs.md → components_components-validationmessage-docs.md} +230 -61
  64. package/generated/docs/components_contact-us-docs.md +12 -0
  65. package/generated/docs/{foundations-accessibility-docs.md → components_foundations-accessibility-docs.md} +11 -21
  66. package/generated/docs/{foundations-colours-docs.md → components_foundations-colour-030-colours.md} +8 -15
  67. package/generated/docs/{foundations-consistency-docs.md → components_foundations-consistency-docs.md} +12 -20
  68. package/generated/docs/{foundations-content-docs.md → components_foundations-content-docs.md} +6 -11
  69. package/generated/docs/components_foundations-introduction-docs.md +15 -0
  70. package/generated/docs/{foundations-principles-docs.md → components_foundations-principles-docs.md} +14 -24
  71. package/generated/docs/components_foundations-typography-docs.md +608 -0
  72. package/generated/docs/{foundations-user-experience-docs.md → components_foundations-user-experience-docs.md} +16 -26
  73. package/generated/docs/{foundations-visual-design-docs.md → components_foundations-visual-design-docs.md} +10 -17
  74. package/generated/docs/{frequently-asked-questions-docs.md → components_frequently-asked-questions-docs.md} +14 -23
  75. package/generated/docs/components_get-started-develop-docs.md +84 -0
  76. package/generated/docs/components_get-started-using-storybook-docs.md +55 -0
  77. package/generated/docs/components_introduction-docs.md +15 -0
  78. package/generated/docs/{patterns-loading-docs.md → components_patterns-loading-docs.md} +711 -143
  79. package/generated/docs/components_resources-changelog-docs.md +4 -0
  80. package/generated/docs/{resources-code-katas-docs.md → components_resources-code-katas-docs.md} +5 -9
  81. package/generated/docs/{resources-migration-guides-from-v4-to-v5-docs.md → components_resources-migration-guides-from-v4-to-v5-docs.md} +54 -239
  82. package/generated/docs/{versions-docs.md → components_versions-docs.md} +5 -8
  83. package/generated/docs/guidelines.md +484 -200
  84. package/generated/docs/introduction-docs.md +19 -30
  85. package/package.json +41 -45
  86. package/generated/docs/components-alert-docs.md +0 -130
  87. package/generated/docs/components-autocomplete-docs.md +0 -754
  88. package/generated/docs/components-button-docs.md +0 -362
  89. package/generated/docs/components-button-recipes-docs.md +0 -76
  90. package/generated/docs/components-buttongroup-docs.md +0 -310
  91. package/generated/docs/components-card-docs.md +0 -494
  92. package/generated/docs/components-checkbox-docs.md +0 -193
  93. package/generated/docs/components-combobox-docs.md +0 -1016
  94. package/generated/docs/components-filter-docs.md +0 -1109
  95. package/generated/docs/components-hide-docs.md +0 -265
  96. package/generated/docs/components-icon-docs.md +0 -553
  97. package/generated/docs/components-input-docs.md +0 -335
  98. package/generated/docs/components-input-recipes-docs.md +0 -140
  99. package/generated/docs/components-inputcurrency-docs.md +0 -157
  100. package/generated/docs/components-label-docs.md +0 -135
  101. package/generated/docs/components-menu-docs.md +0 -704
  102. package/generated/docs/components-menu-menuitem-docs.md +0 -193
  103. package/generated/docs/components-navbar-docs.md +0 -291
  104. package/generated/docs/components-placeholder-docs.md +0 -27
  105. package/generated/docs/components-popover-docs.md +0 -464
  106. package/generated/docs/components-progress-docs.md +0 -104
  107. package/generated/docs/components-radio-docs.md +0 -107
  108. package/generated/docs/components-readonly-docs.md +0 -89
  109. package/generated/docs/components-richselect-docs.md +0 -2433
  110. package/generated/docs/components-skeleton-docs.md +0 -214
  111. package/generated/docs/components-slideout-docs.md +0 -538
  112. package/generated/docs/components-slider-docs.md +0 -346
  113. package/generated/docs/components-spinner-docs.md +0 -59
  114. package/generated/docs/components-table-ag-grid-docs.md +0 -2666
  115. package/generated/docs/components-table-docs.md +0 -1305
  116. package/generated/docs/components-tabset-docs.md +0 -341
  117. package/generated/docs/components-tabset-tab-docs.md +0 -86
  118. package/generated/docs/components-tag-docs.md +0 -115
  119. package/generated/docs/components-toaster-toast-docs.md +0 -157
  120. package/generated/docs/components-toggle-docs.md +0 -158
  121. package/generated/docs/contact-us-docs.md +0 -27
  122. package/generated/docs/extensions-editor-docs.md +0 -288
  123. package/generated/docs/extensions-editor-recipes-docs.md +0 -39
  124. package/generated/docs/foundations-introduction-docs.md +0 -17
  125. package/generated/docs/foundations-typography-docs.md +0 -191
  126. package/generated/docs/get-started-develop-docs.md +0 -48
  127. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  128. package/generated/docs/resources-changelog-docs.md +0 -6
  129. package/generated/docs/themes-available-themes-docs.md +0 -66
  130. package/generated/docs/themes-introduction-docs.md +0 -121
  131. package/generated/docs/themes-tokens-docs.md +0 -1200
  132. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,11 +1,13 @@
1
- [](#container)Container
2
- =======================
1
+ Container
2
+ =========
3
3
 
4
4
  Overview
5
5
  --------
6
6
 
7
7
  `IressContainer` provides a means to center and horizontally pad your site’s contents.
8
8
 
9
+ [](./iframe.html?id=components-container--container)
10
+
9
11
  IressContainer improves the scannability and visual hierarchy of a user interface by snapping the layout to fixed max widths at different breakpoints.
10
12
 
11
13
  Try resizing the screen to see the difference.
@@ -13,11 +15,9 @@ Try resizing the screen to see the difference.
13
15
  Your screen size is showing the container for the **xl** breakpoint.
14
16
 
15
17
  * Screen width range: 1200px - 1499px
16
- * Max width: 1160px
17
-
18
- Hide code
18
+ * Max width: 1280px
19
19
 
20
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
20
+ ```
21
21
 
22
22
  <IressContainer\>
23
23
  <p\>
@@ -25,14 +25,37 @@ Hide code
25
25
  <p\>
26
26
  Try resizing the screen to see the difference. </p\>
27
27
  <IressPanel\>
28
- <CurrentBreakpoint renderLabel\="container" />
28
+ <kn renderLabel\="container" />
29
29
  </IressPanel\>
30
30
  </IressContainer\>
31
31
 
32
- Copy
32
+ ```
33
+
34
+ Props
35
+ -----
36
+
37
+ | Name | Description | Default | Control |
38
+ | --- | --- | --- | --- |
39
+ | children |
40
+ Any content you would like to be contained. Best used with `IressRow` and `IressCol`.
41
+
42
+ ReactReactNode
43
+
44
+
45
+
46
+ | \- | \- |
47
+ | fluid |
48
+
49
+ Container stretches to fill the width of the browser window if true.
50
+
51
+ boolean
52
+
53
+
54
+
55
+ | \- | Set boolean |
33
56
 
34
- [](#behaviour)Behaviour
35
- -----------------------
57
+ Behaviour
58
+ ---------
36
59
 
37
60
  The `IressContainer` snaps to fixed max widths at different breakpoints. Those max widths are as follows:
38
61
 
@@ -46,13 +69,15 @@ Container breakpoints
46
69
  | xl | 1200px - 1499px | 1160px |
47
70
  | xxl | 1500px and above | 1160px |
48
71
 
49
- [](#examples)Examples
50
- ---------------------
72
+ Examples
73
+ --------
51
74
 
52
- ### [](#fluid)Fluid
75
+ ### Fluid
53
76
 
54
77
  If you want the `IressContainer` to fill its containing element, you can set the `fluid` prop. Resize the example below to see how the IressContainer is 100% for all screen sizes.
55
78
 
79
+ [](./iframe.html?id=components-container--fluid)
80
+
56
81
  IressContainer improves the scannability and visual hierarchy of a user interface by snapping the layout to fixed max widths at different breakpoints.
57
82
 
58
83
  When the `fluid` prop is enabled, the container will span the full width of its containing element. Try resizing the screen to see how the IressContainer is 100% for all screen sizes.
@@ -62,9 +87,7 @@ Your screen size is showing the container for the **xl** breakpoint.
62
87
  * Screen width range: 1200px - 1499px
63
88
  * Max width: 100%
64
89
 
65
- Hide code
66
-
67
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
90
+ ```
68
91
 
69
92
  <IressContainer fluid\>
70
93
  <p\>
@@ -76,16 +99,30 @@ Hide code
76
99
  {' '}prop is enabled, the container will span the full width of its containing element. Try resizing the screen to see how the IressContainer is 100% for all screen sizes.
77
100
  </p\>
78
101
  <IressPanel\>
79
- <CurrentBreakpoint renderLabel\="container-fluid" />
102
+ <kn renderLabel\="container-fluid" />
80
103
  </IressPanel\>
81
104
  </IressContainer\>
82
105
 
83
- Copy
106
+ ```
107
+
108
+ #### Props
109
+
110
+ | Name | Description | Default | Control |
111
+ | --- | --- | --- | --- |
112
+ | children |
113
+ Any content you would like to be contained. Best used with `IressRow` and `IressCol`.
114
+
115
+ ReactReactNode
116
+
117
+
118
+
119
+ | \- | \- |
120
+ | fluid |
121
+
122
+ Container stretches to fill the width of the browser window if true.
123
+
124
+ boolean
125
+
84
126
 
85
- On this page
86
127
 
87
- * [Overview](#overview)
88
- * [Props](#props)
89
- * [Behaviour](#behaviour)
90
- * [Examples](#examples)
91
- * [Fluid](#fluid)
128
+ | \- | FalseTrue |
@@ -1,37 +1,60 @@
1
- [](#divider)Divider
2
- ===================
1
+ Divider
2
+ =======
3
3
 
4
4
  Overview
5
5
  --------
6
6
 
7
7
  A divider is a UI element that separates content in lists and layouts.
8
8
 
9
- * * *
9
+ [](./iframe.html?id=components-divider--horizontal)
10
10
 
11
- Hide code
11
+ * * *
12
12
 
13
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
13
+ ```
14
14
 
15
15
  <IressDivider />
16
16
 
17
- Copy
17
+ ```
18
+
19
+ Props
20
+ -----
21
+
22
+ | Name | Description | Default | Control |
23
+ | --- | --- | --- | --- |
24
+ | gutter |
25
+ Sets gutter of the divider.
26
+
27
+ GutterSizes
28
+
29
+
30
+
31
+ | \- | Set object |
32
+ | vertical |
33
+
34
+ Change to a vertical divider.
35
+
36
+ boolean
18
37
 
19
- [](#examples)Examples
20
- ---------------------
21
38
 
22
- ### [](#vertical-divider)Vertical divider
39
+
40
+ | \- | Set boolean |
41
+
42
+ Examples
43
+ --------
44
+
45
+ ### Vertical divider
23
46
 
24
47
  Use the `vertical` prop to change the divider from horizontal to vertical.
25
48
 
49
+ [](./iframe.html?id=components-divider--vertical)
50
+
26
51
  Separate
27
52
 
28
53
  * * *
29
54
 
30
55
  this
31
56
 
32
- Hide code
33
-
34
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
57
+ ```
35
58
 
36
59
  <IressInline
37
60
  gutter\="md"
@@ -44,12 +67,36 @@ Hide code
44
67
  this </IressText\>
45
68
  </IressInline\>
46
69
 
47
- Copy
70
+ ```
71
+
72
+ #### Props
73
+
74
+ | Name | Description | Default | Control |
75
+ | --- | --- | --- | --- |
76
+ | gutter |
77
+ Sets gutter of the divider.
78
+
79
+ GutterSizes
48
80
 
49
- ### [](#gutter)Gutter
81
+
82
+
83
+ | \- | Set object |
84
+ | vertical |
85
+
86
+ Change to a vertical divider.
87
+
88
+ boolean
89
+
90
+
91
+
92
+ | \- | FalseTrue |
93
+
94
+ ### Gutter
50
95
 
51
96
  You can customise the gutter by using the `gutter` prop. By default, the divider uses the theme's default spacing as the gutter.
52
97
 
98
+ [](./iframe.html?id=components-divider--gutter)
99
+
53
100
  none
54
101
  ----
55
102
 
@@ -104,9 +151,7 @@ Separate
104
151
 
105
152
  this
106
153
 
107
- Hide code
108
-
109
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
154
+ ```
110
155
 
111
156
  <IressInline gutter\="md"\>
112
157
  <IressPanel\>
@@ -165,12 +210,26 @@ Hide code
165
210
  </IressPanel\>
166
211
  </IressInline\>
167
212
 
168
- Copy
213
+ ```
214
+
215
+ #### Props
216
+
217
+ | Name | Description | Default | Control |
218
+ | --- | --- | --- | --- |
219
+ | gutter |
220
+ Sets gutter of the divider.
221
+
222
+ GutterSizes
223
+
224
+
225
+
226
+ | \- | \- |
227
+ | vertical |
228
+
229
+ Change to a vertical divider.
230
+
231
+ boolean
232
+
169
233
 
170
- On this page
171
234
 
172
- * [Overview](#overview)
173
- * [Props](#props)
174
- * [Examples](#examples)
175
- * [Vertical divider](#vertical-divider)
176
- * [Gutter](#gutter)
235
+ | \- | Set boolean |
@@ -1,37 +1,103 @@
1
- [](#expander)Expander
2
- =====================
1
+ Expander
2
+ ========
3
3
 
4
4
  Overview
5
5
  --------
6
6
 
7
7
  Expanders are commonly used to reveal more information or details about an element or content on a page.
8
8
 
9
+ [](./iframe.html?id=components-expander--default)
10
+
9
11
  Expander activator
10
12
 
11
13
  Expander content will go here (it is unformatted by default, use IressText to format the text)
12
14
 
13
- Hide code
14
-
15
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
15
+ ```
16
16
 
17
17
  <IressExpander activator\="Expander activator"\>
18
18
  Expander content will go here (it is unformatted by default, use IressText to format the text)
19
19
  </IressExpander\>
20
20
 
21
- Copy
21
+ ```
22
+
23
+ Props
24
+ -----
25
+
26
+ | Name | Description | Default | Control |
27
+ | --- | --- | --- | --- |
28
+ | activator\* |
29
+ The element used to activate the expandable container.
30
+
31
+ ReactNode
32
+
33
+
34
+
35
+ | \- |
36
+
37
+ "Expander activator"
38
+
39
+ |
40
+ | children |
41
+
42
+ Contents that will be expanded/collapsed when the expander is activated.
43
+
44
+ ReactNode
45
+
46
+
47
+
48
+ | \- |
49
+
50
+ "Expander content will go here (it is unformatted by default, use IressText to format the text)"
51
+
52
+ |
53
+ | mode |
54
+
55
+ Controls the display mode of the activator element. Can be Section, Heading or Link.
56
+
57
+ union
58
+
59
+
60
+
61
+ |
62
+
63
+ 'section'
64
+
65
+ | Set object |
66
+ | onChange |
67
+
68
+ Emitted when the open state changes.
69
+
70
+ (newValue: ExpanderActivatorClickEventDetail) => void
71
+
72
+ | \- | \- |
73
+ | open |
74
+
75
+ When true the expandable container will be visible and the activator will display as open.
76
+
77
+ boolean
78
+
79
+
80
+
81
+ |
82
+
83
+ false
22
84
 
23
- [](#accessibility)Accessibility
24
- -------------------------------
85
+ | Set boolean |
86
+
87
+ Accessibility
88
+ -------------
25
89
 
26
90
  For Accessibility guidelines refer to [W3 ARIA Patterns Disclosure](https://www.w3.org/WAI/ARIA/apg/patterns/disclosure/), [W3 ARIA Patterns Accordion](https://www.w3.org/WAI/ARIA/apg/patterns/accordion/).
27
91
 
28
- [](#examples)Examples
29
- ---------------------
92
+ Examples
93
+ --------
30
94
 
31
- ### [](#mode)Mode
95
+ ### Mode
32
96
 
33
97
  Expander has a `mode` prop which can be used to change how the expander is displayed. There are 3 modes `section` (default), `heading` and `link`.
34
98
 
99
+ [](./iframe.html?id=components-expander--mode)
100
+
35
101
  section mode
36
102
  ------------
37
103
 
@@ -53,9 +119,7 @@ link mode
53
119
 
54
120
  Okay, so 9:00 you are strolling through the parking lot, you see us struggling in the car, you walk up, you open the door and you say, your line, George.
55
121
 
56
- Hide code
57
-
58
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
122
+ ```
59
123
 
60
124
  <div className\="iress-u-stack iress--gutter--md"\>
61
125
  <div\>
@@ -135,19 +199,74 @@ Hide code
135
199
  </div\>
136
200
  </div\>
137
201
 
138
- Copy
202
+ ```
203
+
204
+ #### Props
205
+
206
+ | Name | Description | Default | Control |
207
+ | --- | --- | --- | --- |
208
+ | activator\* |
209
+ The element used to activate the expandable container.
210
+
211
+ ReactNode
212
+
213
+
214
+
215
+ | \- | \- |
216
+ | children |
217
+
218
+ Contents that will be expanded/collapsed when the expander is activated.
219
+
220
+ ReactNode
221
+
222
+
223
+
224
+ | \- | \- |
225
+ | mode |
226
+
227
+ Controls the display mode of the activator element. Can be Section, Heading or Link.
228
+
229
+ union
230
+
231
+
232
+
233
+ |
234
+
235
+ 'section'
236
+
237
+ | \- |
238
+ | onChange |
239
+
240
+ Emitted when the open state changes.
241
+
242
+ (newValue: ExpanderActivatorClickEventDetail) => void
243
+
244
+ | \- | \- |
245
+ | open |
246
+
247
+ When true the expandable container will be visible and the activator will display as open.
248
+
249
+ boolean
250
+
251
+
252
+
253
+ |
254
+
255
+ false
256
+
257
+ | Set boolean |
139
258
 
140
- ### [](#open)Open
259
+ ### Open
141
260
 
142
261
  The `open` prop can be used to control the open state of the expander as can be seen below.
143
262
 
263
+ [](./iframe.html?id=components-expander--open)
264
+
144
265
  Expander activator
145
266
 
146
267
  Expander content will go here (it is unformatted by default, use IressText to format the text)
147
268
 
148
- Hide code
149
-
150
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
269
+ ```
151
270
 
152
271
  <IressExpander
153
272
  activator\="Expander activator"
@@ -157,12 +276,81 @@ Hide code
157
276
  Expander content will go here (it is unformatted by default, use IressText to format the text)
158
277
  </IressExpander\>
159
278
 
160
- Copy
279
+ ```
280
+
281
+ #### Props
282
+
283
+ | Name | Description | Default | Control |
284
+ | --- | --- | --- | --- |
285
+ | activator\* |
286
+ The element used to activate the expandable container.
287
+
288
+ ReactNode
289
+
290
+
291
+
292
+ | \- |
293
+
294
+ "Expander activator"
295
+
296
+ |
297
+ | children |
298
+
299
+ Contents that will be expanded/collapsed when the expander is activated.
300
+
301
+ ReactNode
302
+
303
+
304
+
305
+ | \- |
306
+
307
+ "Expander content will go here (it is unformatted by default, use IressText to format the text)"
308
+
309
+ |
310
+ | mode |
311
+
312
+ Controls the display mode of the activator element. Can be Section, Heading or Link.
313
+
314
+ union
315
+
316
+
317
+
318
+ |
319
+
320
+ 'section'
321
+
322
+ |
323
+
324
+ "heading"
325
+
326
+ |
327
+ | onChange |
328
+
329
+ Emitted when the open state changes.
330
+
331
+ (newValue: ExpanderActivatorClickEventDetail) => void
332
+
333
+ | \- | \- |
334
+ | open |
335
+
336
+ When true the expandable container will be visible and the activator will display as open.
337
+
338
+ boolean
339
+
161
340
 
162
- ### [](#multiple-expanders-accordion)Multiple expanders (accordion)
341
+
342
+ |
343
+
344
+ false
345
+
346
+ | FalseTrue |
347
+
348
+ ### Multiple expanders (accordion)
163
349
 
164
350
  You can use multiple expanders to create an accordion, where al expander closes when another is opened.
165
351
 
352
+ [](./iframe.html?id=components-expander--multiple)
353
+
166
354
  top
167
355
 
168
356
  Top
@@ -173,9 +361,7 @@ bottom
173
361
  Bottom
174
362
  ------
175
363
 
176
- Hide code
177
-
178
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
364
+ ```
179
365
 
180
366
  export const MultipleExpander \= () \=> {
181
367
  const \[openActivator, setOpenActivator\] \= useState('');
@@ -202,14 +388,59 @@ export const MultipleExpander \= () \=> {
202
388
  );
203
389
  };
204
390
 
205
- Copy
391
+ ```
392
+
393
+ #### Props
394
+
395
+ | Name | Description | Default | Control |
396
+ | --- | --- | --- | --- |
397
+ | activator\* |
398
+ The element used to activate the expandable container.
399
+
400
+ ReactNode
401
+
402
+
403
+
404
+ | \- | \- |
405
+ | children |
406
+
407
+ Contents that will be expanded/collapsed when the expander is activated.
408
+
409
+ ReactNode
410
+
411
+
412
+
413
+ | \- | \- |
414
+ | mode |
415
+
416
+ Controls the display mode of the activator element. Can be Section, Heading or Link.
417
+
418
+ union
419
+
420
+
421
+
422
+ |
423
+
424
+ 'section'
425
+
426
+ | \- |
427
+ | onChange |
428
+
429
+ Emitted when the open state changes.
430
+
431
+ (newValue: ExpanderActivatorClickEventDetail) => void
432
+
433
+ | \- | \- |
434
+ | open |
435
+
436
+ When true the expandable container will be visible and the activator will display as open.
437
+
438
+ boolean
439
+
440
+
441
+
442
+ |
206
443
 
207
- On this page
444
+ false
208
445
 
209
- * [Overview](#overview)
210
- * [Props](#props)
211
- * [Accessibility](#accessibility)
212
- * [Examples](#examples)
213
- * [Mode](#mode)
214
- * [Open](#open)
215
- * [Multiple expanders (accordion)](#multiple-expanders-accordion)
446
+ | \- |