@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,494 +0,0 @@
1
- [](#card)Card
2
- =============
3
-
4
- Overview
5
- --------
6
-
7
- Cards are used to group small, related pieces of information into one digestible unit.
8
-
9
- Read more
10
-
11
- A single card will typically include a few different types of media, such as an image, a title, a synopsis, a call-to-action button or sub actions buttons - all associated with the same concept.
12
-
13
- Cards can be configured in a variety of ways. You can use the render props (slots) if you want to create a structured layout, or you can create a custom card with your own markup if you need more flexibility.
14
-
15
- I'm a card
16
-
17
- Hide code
18
-
19
- \[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
- <IressCard\>
22
- I'm a card
23
- </IressCard\>
24
-
25
- Copy
26
-
27
- [](#examples)Examples
28
- ---------------------
29
-
30
- ### [](#simple-cards)Simple cards
31
-
32
- All slots and props for card are optional. You can create a simple card by adding some content to the default slot.
33
-
34
- I'm a simple card
35
-
36
- Hide code
37
-
38
- \[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; }
39
-
40
- <IressCard\>
41
- I'm a simple card
42
- </IressCard\>
43
-
44
- Copy
45
-
46
- ### [](#padding)Padding
47
-
48
- Padding can be controlled using the `padding` prop. It can be set to `none`, `sm`, `md` or `lg`. It defaults to `md`.
49
-
50
- I’m a card with none padding
51
-
52
- I’m a card with sm padding
53
-
54
- I’m a card with md padding
55
-
56
- I’m a card with lg padding
57
-
58
- Hide code
59
-
60
- \[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; }
61
-
62
- <div className\="iress-u-stack iress--gutter--md"\>
63
- <IressCard padding\="none"\>
64
- I’m a card with none padding </IressCard\>
65
- <IressCard padding\="sm"\>
66
- I’m a card with sm padding </IressCard\>
67
- <IressCard padding\="md"\>
68
- I’m a card with md padding </IressCard\>
69
- <IressCard padding\="lg"\>
70
- I’m a card with lg padding </IressCard\>
71
- </div\>
72
-
73
- Copy
74
-
75
- ### [](#stretch)Stretch
76
-
77
- The `stretch` prop can be used to stretch the card to fill its container.
78
-
79
- I’m a stretched card
80
-
81
- I’m a card with lots of content. Blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah.
82
-
83
- Hide code
84
-
85
- \[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; }
86
-
87
- <IressRow
88
- gutter\="md"
89
- verticalAlign\="stretch"
90
- \>
91
- <IressCol\>
92
- <IressCard stretch\>
93
- I’m a stretched card </IressCard\>
94
- </IressCol\>
95
- <IressCol\>
96
- <IressCard\>
97
- I’m a card with lots of content. Blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah. </IressCard\>
98
- </IressCol\>
99
- </IressRow\>
100
-
101
- Copy
102
-
103
- ### [](#selected)Selected
104
-
105
- Setting the `selected` prop highlights the card, usually to allow selection in a list.
106
-
107
- I'm a selected card
108
-
109
- Hide code
110
-
111
- \[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; }
112
-
113
- <IressCard selected\>
114
- I'm a selected card
115
- </IressCard\>
116
-
117
- Copy
118
-
119
- [](#render-props-slots)Render props (slots)
120
- -------------------------------------------
121
-
122
- If you're coming from v4 or earlier, you might be used to slots. In v5, we've replaced slots with render props which align with the React API. Render props allow you to create a structured layout for your card, while still having the flexibility to add custom content. They are simply functions that return JSX, so you can pass any component you like.
123
-
124
- However, please be diligent as the component you use may not fit withing the confines of the `IressCard` layout.
125
-
126
- ### [](#prepend)Prepend
127
-
128
- Use the `prepend` prop to add content to the left side of the card.
129
-
130
- I'm a card using the prepend render prop
131
-
132
- Hide code
133
-
134
- \[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; }
135
-
136
- <IressCard prepend\={<IressIcon name\="star" />}\>
137
- I'm a card using the prepend render prop
138
- </IressCard\>
139
-
140
- Copy
141
-
142
- ### [](#top-right)Top Right
143
-
144
- Use the `topRight` prop to add content to the top right of the card. This is useful for adding a badge, icon, or an actions menu.
145
-
146
- More actions in here
147
-
148
- I'm a card using the topRight render prop
149
-
150
- Hide code
151
-
152
- \[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; }
153
-
154
- <IressCard topRight\={<IressPopover activator\={<IressButton\><IressIcon name\="ellipsis-v" size\="lg"/></IressButton\>} align\="bottom-end"\><IressPanel\>More actions in here</IressPanel\></IressPopover\>}\>
155
- I'm a card using the topRight render prop
156
- </IressCard\>
157
-
158
- Copy
159
-
160
- ### [](#heading)Heading
161
-
162
- Use the `heading` prop to add a header to the card. The header can be any component you like, but it is designed to support a simple heading element, optionally wrapped with a link.
163
-
164
- **Note:** `headingText` and `headingLevel` props have been replaced with the `heading` render prop to give you more control over the heading element and its content. To use the previous behaviour, you can pass a string which will automatically create a `h2` element, or pass a `h*` element with the text as a child.
165
-
166
- ### Welcome to Iress!
167
-
168
- I'm a card using the heading render prop
169
-
170
- Hide code
171
-
172
- \[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; }
173
-
174
- <IressCard heading\={<h3\>Welcome to Iress!</h3\>}\>
175
- I'm a card using the heading render prop
176
- </IressCard\>
177
-
178
- Copy
179
-
180
- ### [](#media)Media
181
-
182
- Use the `media` prop to add media to the card. The media can be any component you like, but it is designed to support an image or video.
183
-
184
- ![A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground](https://www.iress.com/media/images/media-contact.width-600.png)
185
-
186
- I'm a card using the media render prop
187
-
188
- Hide code
189
-
190
- \[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; }
191
-
192
- <IressCard media\={<img alt\="A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground" src\="https://www.iress.com/media/images/media-contact.width-600.png" width\="250"/>}\>
193
- I'm a card using the media render prop
194
- </IressCard\>
195
-
196
- Copy
197
-
198
- ### [](#content)Content
199
-
200
- Use the `content` prop to add content to the card. The content can be any component you like, but it is designed to support simple text based elements.
201
-
202
- Find out all the onboarding material you need
203
- [with this easy guide](https://iress.com).
204
-
205
- Hide code
206
-
207
- \[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; }
208
-
209
- <IressCard\>
210
- <IressText\>
211
- Find out all the onboarding material you need{' '}
212
- <br />
213
- <a href\="https://iress.com"\>
214
- with this easy guide </a\>
215
- . </IressText\>
216
- </IressCard\>
217
-
218
- Copy
219
-
220
- ### [](#footer)Footer
221
-
222
- Use the `footer` prop to add a footer to the card. The footer can be any component you like, but it is designed to support buttons.
223
-
224
- I'm a card using the footer render prop
225
-
226
- #new-starter#first-day
227
-
228
- NEW
229
-
230
- Hide code
231
-
232
- \[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; }
233
-
234
- <IressCard footer\={<IressInline gutter\="sm" horizontalAlign\="between"\><IressInline gutter\="sm"\><IressBadge mode\="background-default" pill\>#new-starter</IressBadge\><IressBadge mode\="background-default" pill\>#first-day</IressBadge\></IressInline\><IressBadge mode\="positive"\>NEW</IressBadge\></IressInline\>}\>
235
- I'm a card using the footer render prop
236
- </IressCard\>
237
-
238
- Copy
239
-
240
- ### [](#all-slots)All slots
241
-
242
- You can use all the slots together to create a custom card layout.
243
-
244
- prepend
245
-
246
- media
247
-
248
- heading
249
-
250
- topRight
251
-
252
- children
253
-
254
- footer
255
-
256
- * * *
257
-
258
- More actions in here
259
-
260
- ![A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground](https://www.iress.com/media/images/media-contact.width-600.png)
261
-
262
- ### Welcome to Iress!
263
-
264
- Find out all the onboarding material you need
265
- [with this easy guide](https://iress.com).
266
-
267
- #new-starter#first-day
268
-
269
- NEW
270
-
271
- More actions in here
272
-
273
- ![A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground](https://www.iress.com/media/images/media-contact.width-600.png)
274
-
275
- ### Welcome to Iress!
276
-
277
- Find out all the onboarding material you need
278
- [with this easy guide](https://iress.com).
279
-
280
- #new-starter#first-day
281
-
282
- NEW
283
-
284
- More actions in here
285
-
286
- ![A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground](https://www.iress.com/media/images/media-contact.width-600.png)
287
-
288
- ### Welcome to Iress!
289
-
290
- Find out all the onboarding material you need
291
- [with this easy guide](https://iress.com).
292
-
293
- #new-starter#first-day
294
-
295
- NEW
296
-
297
- Hide code
298
-
299
- \[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; }
300
-
301
- const supportedCardSlots \= {
302
- prepend: <IressIcon name\="star" />,
303
- media: (
304
- <img
305
- src\="https://www.iress.com/media/images/media-contact.width-600.png"
306
- width\="250"
307
- alt\="A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground"
308
- />
309
- ),
310
- heading: <h3\>Welcome to Iress!</h3\>,
311
- topRight: (
312
- <IressPopover
313
- align\="bottom-end"
314
- activator\={
315
- <IressButton\>
316
- <IressIcon name\="ellipsis-v" size\="lg" />
317
- </IressButton\>
318
- }
319
- \>
320
- <IressPanel\>More actions in here</IressPanel\>
321
- </IressPopover\>
322
- ),
323
- children: (
324
- <IressText\>
325
- Find out all the onboarding material you need <br />
326
- <a href\="https://iress.com"\>with this easy guide</a\>.
327
- </IressText\>
328
- ),
329
- footer: (
330
- <IressInline gutter\="sm" horizontalAlign\="between"\>
331
- <IressInline gutter\="sm"\>
332
- <IressBadge pill mode\="background-default"\>
333
- #new-starter </IressBadge\>
334
- <IressBadge pill mode\="background-default"\>
335
- #first-day </IressBadge\>
336
- </IressInline\>
337
- <IressBadge mode\="positive"\>NEW</IressBadge\>
338
- </IressInline\>
339
- ),
340
- };
341
- const SUPPORTED\_CARD\_SLOTS \= Object.keys(supportedCardSlots);
342
- type SupportedCardSlots \= keyof typeof supportedCardSlots;
343
-
344
- export const CardAllSlots \= () \=> {
345
- const \[show, setShow\] \= useState({
346
- children: true,
347
- prepend: false,
348
- media: true,
349
- heading: true,
350
- topRight: true,
351
- footer: true,
352
- });
353
- const filteredArgs \= Object.fromEntries(
354
- Object.entries(supportedCardSlots).filter(
355
- (\[key\]) \=> show\[key as SupportedCardSlots\] || !(key in show),
356
- ),
357
- );
358
- return (
359
- <IressContainer\>
360
- <IressInline gutter\="md"\>
361
- {SUPPORTED\_CARD\_SLOTS.map((slot) \=> (
362
- <IressToggle
363
- key\={slot}
364
- checked\={show\[slot as never\]}
365
- onChange\={(checked) \=> {
366
- setShow({ ...show, \[slot\]: checked });
367
- }}
368
- \>
369
- {slot}
370
- </IressToggle\>
371
- ))}
372
- </IressInline\>
373
- <hr />
374
- <IressRow gutter\="md"\>
375
- <IressCol\>
376
- <IressCard {...filteredArgs} />
377
- </IressCol\>
378
- <IressCol\>
379
- <IressCard {...filteredArgs} />
380
- </IressCol\>
381
- <IressCol\>
382
- <IressCard {...filteredArgs} />
383
- </IressCol\>
384
- </IressRow\>
385
- </IressContainer\>
386
- );
387
- };
388
-
389
- Copy
390
-
391
- [](#clickable-cards)Clickable cards
392
- -----------------------------------
393
-
394
- Note: The `clickable` prop has been deprecated in favour of using component variations, or the `onClick` prop.
395
-
396
- ### [](#heading-only)Heading only
397
-
398
- Since the `heading` prop now renders the component you give it, you have full control over the content of the `heading`. This means you can add pass it a heading with a link.
399
-
400
- [Clickable heading](https://iress.com)
401
- --------------------------------------
402
-
403
- I'm a card with a clickable heading. NEVER use me when the whole card is clickable.
404
-
405
- Hide code
406
-
407
- \[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; }
408
-
409
- <IressCard heading\={<h2\><a href\="https://iress.com"\>Clickable heading</a\></h2\>}\>
410
- I'm a card with a clickable heading. NEVER use me when the whole card is clickable.
411
- </IressCard\>
412
-
413
- Copy
414
-
415
- ### [](#whole-card)Whole card
416
-
417
- The whole card can be made clickable by passing an `onClick` prop. All the appropriate styling will be added as well.
418
-
419
- It's recommended to add `role="button"` and `tabindex="0"` to the card to make it clear to screen readers that the card is clickable.
420
-
421
- I am a card with an onClick handler. Click me to see what happens.
422
-
423
- Hide code
424
-
425
- \[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; }
426
-
427
- <IressCard
428
- onClick\={() \=> alert("Card clicked")}
429
- onKeyDown\={() \=> alert("Key down on card (for keyboard users)")}
430
- role\="button"
431
- tabIndex\={0}
432
- \>
433
- I am a card with an onClick handler. Click me to see what happens.
434
- </IressCard\>
435
-
436
- Copy
437
-
438
- ### [](#links-and-buttons)Links and Buttons
439
-
440
- To simplify the process of making the whole card clickable, you can use the `IressLinkCard` and `IressButtonCard` components. These components look exactly the same as the `IressCard` component, however their base tags are different, allowing you to use them exactly like you would a html link and button.
441
-
442
- **Note:** These components replace the `button`, `clickable` and `href` props. You no longer need `button` and `clickable`, as these are automatically inferred. To mimic the `href` prop, simply change the component you are using to `IressLinkCard`.
443
-
444
- I am a card with a button element
445
-
446
- Hide code
447
-
448
- \[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; }
449
-
450
- <IressButtonCard
451
- onClick\={() \=> alert("Card clicked")}
452
- type\="button"
453
- \>
454
- I am a card with a button element
455
- </IressButtonCard\>
456
-
457
- Copy
458
-
459
- [I am a card with an anchor element](https://iress.com)
460
-
461
- Hide code
462
-
463
- \[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; }
464
-
465
- <IressLinkCard
466
- href\="https://iress.com"
467
- target\="\_blank"
468
- \>
469
- I am a card with an anchor element
470
- </IressLinkCard\>
471
-
472
- Copy
473
-
474
- On this page
475
-
476
- * [Overview](#overview)
477
- * [Props](#props)
478
- * [Examples](#examples)
479
- * [Simple cards](#simple-cards)
480
- * [Padding](#padding)
481
- * [Stretch](#stretch)
482
- * [Selected](#selected)
483
- * [Render props (slots)](#render-props-slots)
484
- * [Prepend](#prepend)
485
- * [Top Right](#top-right)
486
- * [Heading](#heading)
487
- * [Media](#media)
488
- * [Content](#content)
489
- * [Footer](#footer)
490
- * [All slots](#all-slots)
491
- * [Clickable cards](#clickable-cards)
492
- * [Heading only](#heading-only)
493
- * [Whole card](#whole-card)
494
- * [Links and Buttons](#links-and-buttons)
@@ -1,193 +0,0 @@
1
- [](#checkbox)Checkbox
2
- =====================
3
-
4
- Overview
5
- --------
6
-
7
- Checkboxes are used to let a user select one or more options for a limited number of choices. Also, works as a child of `IressCheckboxGroup`
8
-
9
- A checkbox
10
-
11
- Hide code
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; }
14
-
15
- <IressCheckbox\>
16
- A checkbox
17
- </IressCheckbox\>
18
-
19
- Copy
20
-
21
- [](#usage)Usage
22
- ---------------
23
-
24
- ### [](#checked)Checked
25
-
26
- For single checkboxes in controlled mode the `checked` prop sets the checked state.
27
-
28
- When used as part of an `IressCheckboxGroup`, the `checked` prop will be ignored. Instead, the `value` prop on the `IressCheckboxGroup` will determine the checked state of each checkbox. See the [checkbox group documentation](?path=/docs/components-checkboxgroup--docs) for more details.
29
-
30
- A checkbox which is checked and in controlled mode
31
-
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; }
35
-
36
- <IressCheckbox checked\>
37
- A checkbox which is checked and in controlled mode
38
- </IressCheckbox\>
39
-
40
- Copy
41
-
42
- ### [](#default-checked)Default Checked
43
-
44
- For single checkboxes in uncontrolled mode the `defaultChecked` prop sets the default checked state.
45
-
46
- A checkbox which is initially checked
47
-
48
- Hide code
49
-
50
- \[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; }
51
-
52
- <IressCheckbox defaultChecked\>
53
- A checkbox which is initially checked
54
- </IressCheckbox\>
55
-
56
- Copy
57
-
58
- ### [](#indeterminate)Indeterminate
59
-
60
- The `indeterminate` prop sets the checkbox appearance to an indeterminate dash until it is clicked. It has no impact on the checkbox behavior beyond this purely visual indicator.
61
-
62
- A checkbox which is initially in an indeterminate state
63
-
64
- Hide code
65
-
66
- \[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; }
67
-
68
- <IressCheckbox indeterminate\>
69
- A checkbox which is initially in an indeterminate state
70
- </IressCheckbox\>
71
-
72
- Copy
73
-
74
- ### [](#hidden-label)Hidden Label
75
-
76
- It is very rare to want to render a checkbox without a visible label. However, one case where you might want to is within tables.
77
-
78
- When using a checkbox without a visible label, you must supply a label and apply the `hiddenLabel` property to still be accessible by screen readers.
79
-
80
- It is also important to not hide the table headers.
81
-
82
- List of investments
83
- | Select | Name | Date | Cost |
84
- | --- | --- | --- | --- |
85
- |
86
- Toggle row
87
-
88
- | Artemis Fund Managers Limited | 2019-09-23 | 23898.12 |
89
- |
90
-
91
- Toggle row
92
-
93
- | CASH.CASH | 2020-06-28 | 49751.43 |
94
-
95
- Hide code
96
-
97
- \[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; }
98
-
99
- <IressTable
100
- caption\="List of investments"
101
- columns\={\[
102
- {
103
- format: (value: boolean) \=> <IressCheckbox defaultChecked\={value} hiddenLabel\>Toggle row</IressCheckbox\>,
104
- key: 'select',
105
- label: 'Select',
106
- sort: true
107
- },
108
- {
109
- key: 'name',
110
- label: 'Name'
111
- },
112
- {
113
- key: 'date',
114
- label: 'Date'
115
- },
116
- {
117
- key: 'cost',
118
- label: 'Cost'
119
- }
120
- \]}
121
- rows\={\[
122
- {
123
- cost: 23898.12,
124
- date: '2019-09-23',
125
- name: 'Artemis Fund Managers Limited',
126
- select: false
127
- },
128
- {
129
- cost: 49751.43,
130
- date: '2020-06-28',
131
- name: 'CASH.CASH',
132
- select: true
133
- }
134
- \]}
135
- />
136
-
137
- Copy
138
-
139
- ### [](#readonly)Readonly
140
-
141
- The `readOnly` prop changes how the checkbox is rendered. It will only render if the checkbox is checked (alongside a hidden input that contains the `value` if it was set), otherwise it will not be rendered.
142
-
143
- It is understandable that this may not be the desired behavior for all use cases. If you need a checkbox that is not editable, but still visible, simply do not set the `readonly` prop and set the `checked` prop instead.
144
-
145
- I agree to the terms and conditions
146
-
147
- Hide code
148
-
149
- \[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; }
150
-
151
- <IressStack\>
152
- <IressCheckbox
153
- defaultChecked
154
- readOnly
155
- value\="readonly"
156
- \>
157
- I agree to the terms and conditions </IressCheckbox\>
158
- <IressCheckbox
159
- readOnly
160
- value\="readonly"
161
- \>
162
- I agree to the terms and conditions </IressCheckbox\>
163
- </IressStack\>
164
-
165
- Copy
166
-
167
- ### [](#touch)Touch
168
-
169
- The `touch` prop adds the button-like border and padding to checkbox.
170
-
171
- Checkbox with touch styles
172
-
173
- Hide code
174
-
175
- \[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; }
176
-
177
- <IressCheckbox touch\>
178
- Checkbox with touch styles
179
- </IressCheckbox\>
180
-
181
- Copy
182
-
183
- On this page
184
-
185
- * [Overview](#overview)
186
- * [Props](#props)
187
- * [Usage](#usage)
188
- * [Checked](#checked)
189
- * [Default Checked](#default-checked)
190
- * [Indeterminate](#indeterminate)
191
- * [Hidden Label](#hidden-label)
192
- * [Readonly](#readonly)
193
- * [Touch](#touch)