@iress-oss/ids-mcp-server 6.0.0-alpha.1-canary-20251204032753-fe18cab → 6.0.0-alpha.1-canary-20251204040305-3639454

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 (99) hide show
  1. package/generated/docs/components_components-alert-docs.md +1054 -0
  2. package/generated/docs/components_components-autocomplete-docs.md +3304 -0
  3. package/generated/docs/components_components-autocomplete-recipes-docs.md +98 -0
  4. package/generated/docs/components_components-badge-docs.md +312 -0
  5. package/generated/docs/components_components-button-docs.md +2339 -0
  6. package/generated/docs/components_components-buttongroup-docs.md +980 -0
  7. package/generated/docs/components_components-card-docs.md +1970 -0
  8. package/generated/docs/components_components-checkbox-docs.md +1083 -0
  9. package/generated/docs/components_components-checkboxgroup-docs.md +1597 -0
  10. package/generated/docs/components_components-checkboxgroup-recipes-docs.md +209 -0
  11. package/generated/docs/components_components-col-docs.md +755 -0
  12. package/generated/docs/components_components-container-docs.md +172 -0
  13. package/generated/docs/components_components-divider-docs.md +235 -0
  14. package/generated/docs/components_components-expander-docs.md +428 -0
  15. package/generated/docs/components_components-field-docs.md +3345 -0
  16. package/generated/docs/components_components-filter-docs.md +4091 -0
  17. package/generated/docs/components_components-hide-docs.md +450 -0
  18. package/generated/docs/components_components-icon-docs.md +1017 -0
  19. package/generated/docs/components_components-image-docs.md +168 -0
  20. package/generated/docs/components_components-inline-docs.md +1962 -0
  21. package/generated/docs/components_components-input-docs.md +1388 -0
  22. package/generated/docs/components_components-input-recipes-docs.md +349 -0
  23. package/generated/docs/components_components-inputcurrency-docs.md +636 -0
  24. package/generated/docs/components_components-inputcurrency-recipes-docs.md +208 -0
  25. package/generated/docs/components_components-introduction-docs.md +448 -0
  26. package/generated/docs/components_components-label-docs.md +229 -0
  27. package/generated/docs/components_components-link-docs.md +454 -0
  28. package/generated/docs/components_components-menu-docs.md +2219 -0
  29. package/generated/docs/components_components-menu-menuitem-docs.md +1455 -0
  30. package/generated/docs/components_components-modal-docs.md +2002 -0
  31. package/generated/docs/components_components-panel-docs.md +342 -0
  32. package/generated/docs/components_components-placeholder-docs.md +98 -0
  33. package/generated/docs/components_components-popover-docs.md +1631 -0
  34. package/generated/docs/components_components-popover-recipes-docs.md +537 -0
  35. package/generated/docs/components_components-progress-docs.md +128 -0
  36. package/generated/docs/components_components-provider-docs.md +123 -0
  37. package/generated/docs/components_components-radio-docs.md +499 -0
  38. package/generated/docs/components_components-radiogroup-docs.md +1573 -0
  39. package/generated/docs/components_components-readonly-docs.md +277 -0
  40. package/generated/docs/components_components-richselect-docs.md +6101 -0
  41. package/generated/docs/components_components-row-docs.md +2172 -0
  42. package/generated/docs/components_components-select-docs.md +1110 -0
  43. package/generated/docs/components_components-skeleton-docs.md +467 -0
  44. package/generated/docs/components_components-skeleton-recipes-docs.md +110 -0
  45. package/generated/docs/components_components-skiplink-docs.md +220 -0
  46. package/generated/docs/components_components-slideout-docs.md +1910 -0
  47. package/generated/docs/components_components-slider-docs.md +1284 -0
  48. package/generated/docs/components_components-spinner-docs.md +90 -0
  49. package/generated/docs/components_components-stack-docs.md +730 -0
  50. package/generated/docs/components_components-table-docs.md +4038 -0
  51. package/generated/docs/components_components-tabset-docs.md +955 -0
  52. package/generated/docs/components_components-tabset-tab-docs.md +342 -0
  53. package/generated/docs/components_components-tag-docs.md +410 -0
  54. package/generated/docs/components_components-text-docs.md +593 -0
  55. package/generated/docs/components_components-toaster-docs.md +451 -0
  56. package/generated/docs/components_components-toggle-docs.md +513 -0
  57. package/generated/docs/components_components-tooltip-docs.md +564 -0
  58. package/generated/docs/components_components-validationmessage-docs.md +608 -0
  59. package/generated/docs/components_contact-us-docs.md +9 -0
  60. package/generated/docs/components_foundations-accessibility-docs.md +33 -0
  61. package/generated/docs/components_foundations-consistency-docs.md +44 -0
  62. package/generated/docs/components_foundations-content-docs.md +18 -0
  63. package/generated/docs/components_foundations-introduction-docs.md +17 -0
  64. package/generated/docs/components_foundations-principles-docs.md +60 -0
  65. package/generated/docs/components_foundations-responsive-layout-docs.md +2692 -0
  66. package/generated/docs/components_foundations-user-experience-docs.md +53 -0
  67. package/generated/docs/components_foundations-visual-design-docs.md +39 -0
  68. package/generated/docs/components_foundations-z-index-stacking-docs.md +288 -0
  69. package/generated/docs/components_frequently-asked-questions-docs.md +44 -0
  70. package/generated/docs/components_get-started-develop-docs.md +47 -0
  71. package/generated/docs/components_get-started-using-storybook-docs.md +55 -0
  72. package/generated/docs/components_introduction-docs.md +85 -0
  73. package/generated/docs/components_patterns-form-docs.md +2469 -0
  74. package/generated/docs/components_patterns-form-recipes-docs.md +1597 -0
  75. package/generated/docs/components_patterns-introduction-docs.md +31 -0
  76. package/generated/docs/components_patterns-loading-docs.md +1908 -0
  77. package/generated/docs/components_patterns-shadow-docs.md +195 -0
  78. package/generated/docs/components_resources-code-katas-docs.md +25 -0
  79. package/generated/docs/components_resources-introduction-docs.md +28 -0
  80. package/generated/docs/components_resources-mcp-server-docs.md +23 -0
  81. package/generated/docs/components_resources-migration-guides-from-v4-to-v5-docs.md +142 -0
  82. package/generated/docs/components_styling-props-colour-docs.md +91 -0
  83. package/generated/docs/components_styling-props-elevation-docs.md +69 -0
  84. package/generated/docs/components_styling-props-radius-docs.md +63 -0
  85. package/generated/docs/components_styling-props-reference-docs.md +160 -0
  86. package/generated/docs/components_styling-props-screen-readers-docs.md +66 -0
  87. package/generated/docs/components_styling-props-sizing-docs.md +217 -0
  88. package/generated/docs/components_styling-props-spacing-docs.md +545 -0
  89. package/generated/docs/components_styling-props-typography-docs.md +66 -0
  90. package/generated/docs/components_versions-docs.md +14 -0
  91. package/generated/docs/guidelines.md +3083 -0
  92. package/generated/docs/introduction-docs.md +37 -0
  93. package/generated/docs/tokens_colour-docs.md +479 -0
  94. package/generated/docs/tokens_elevation-docs.md +39 -0
  95. package/generated/docs/tokens_introduction-docs.md +150 -0
  96. package/generated/docs/tokens_radius-docs.md +67 -0
  97. package/generated/docs/tokens_spacing-docs.md +87 -0
  98. package/generated/docs/tokens_typography-docs.md +305 -0
  99. package/package.json +2 -2
@@ -0,0 +1,1970 @@
1
+ Card
2
+ ====
3
+
4
+ Overview
5
+ --------
6
+
7
+ Cards are used to group small, related pieces of information into one digestible unit.
8
+
9
+ * * *
10
+
11
+ Updated
12
+
13
+ **Recently updated**
14
+
15
+ This component has been recently updated with new props. The props have been marked as beta. Please tell us if there are any issues.
16
+
17
+ Read more
18
+
19
+ 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.
20
+
21
+ 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.
22
+
23
+ [](./iframe.html?id=components-card--default)
24
+
25
+ I'm a card
26
+
27
+ ```
28
+
29
+ <IressCard\>
30
+ I'm a card
31
+ </IressCard\>
32
+
33
+ ```
34
+
35
+ Props
36
+ -----
37
+
38
+ | Name | Description | Default | Control |
39
+ | --- | --- | --- | --- |
40
+ | children |
41
+ Main body of the card
42
+
43
+ ReactNode
44
+
45
+
46
+
47
+ | \- |
48
+
49
+ "I'm a card"
50
+
51
+ |
52
+ | element |
53
+
54
+ Element type to render the Card as.
55
+
56
+ E
57
+
58
+
59
+
60
+ | \- | Set object |
61
+ | footer |
62
+
63
+ Section that sticks to the bottom of the card
64
+
65
+ ReactNode
66
+
67
+
68
+
69
+ | \- | Set object |
70
+ | heading |
71
+
72
+ Heading slot. Often used for a title or description.
73
+
74
+ ReactNode
75
+
76
+
77
+
78
+ | \- | Set object |
79
+ | media |
80
+
81
+ Section (often for an image, table or chart) that appears before the heading
82
+
83
+ ReactNode
84
+
85
+
86
+
87
+ | \- | Set object |
88
+ | prepend |
89
+
90
+ Slot to the left of card content.
91
+
92
+ ReactNode
93
+
94
+
95
+
96
+ | \- | Set object |
97
+ | selected |
98
+
99
+ When set to true, card appears selected.
100
+
101
+ boolean
102
+
103
+
104
+
105
+ | \- | Set boolean |
106
+ | topRight |
107
+
108
+ Slot positioned to the top right of the card, often used for an icon or action menu
109
+
110
+ ReactNode
111
+
112
+
113
+
114
+ | \- | Set object |
115
+
116
+ Examples
117
+ --------
118
+
119
+ ### Simple cards
120
+
121
+ All slots and props for card are optional. You can create a simple card by adding some content to the default slot.
122
+
123
+ [](./iframe.html?id=components-card--simple)
124
+
125
+ I'm a simple card
126
+
127
+ ```
128
+
129
+ <IressCard\>
130
+ I'm a simple card
131
+ </IressCard\>
132
+
133
+ ```
134
+
135
+ #### Props
136
+
137
+ | Name | Description | Default | Control |
138
+ | --- | --- | --- | --- |
139
+ | children |
140
+ Main body of the card
141
+
142
+ ReactNode
143
+
144
+
145
+
146
+ | \- |
147
+
148
+ "I'm a simple card"
149
+
150
+ |
151
+ | element |
152
+
153
+ Element type to render the Card as.
154
+
155
+ E
156
+
157
+
158
+
159
+ | \- | Set object |
160
+ | footer |
161
+
162
+ Section that sticks to the bottom of the card
163
+
164
+ ReactNode
165
+
166
+
167
+
168
+ | \- | Set object |
169
+ | heading |
170
+
171
+ Heading slot. Often used for a title or description.
172
+
173
+ ReactNode
174
+
175
+
176
+
177
+ | \- | Set object |
178
+ | media |
179
+
180
+ Section (often for an image, table or chart) that appears before the heading
181
+
182
+ ReactNode
183
+
184
+
185
+
186
+ | \- | Set object |
187
+ | prepend |
188
+
189
+ Slot to the left of card content.
190
+
191
+ ReactNode
192
+
193
+
194
+
195
+ | \- | Set object |
196
+ | selected |
197
+
198
+ When set to true, card appears selected.
199
+
200
+ boolean
201
+
202
+
203
+
204
+ | \- | Set boolean |
205
+ | topRight |
206
+
207
+ Slot positioned to the top right of the card, often used for an icon or action menu
208
+
209
+ ReactNode
210
+
211
+
212
+
213
+ | \- | Set object |
214
+
215
+ ### Padding
216
+
217
+ Padding can be controlled using the `padding` prop. It can be set to `none`, `sm`, `md` or `lg`. It defaults to `md`.
218
+
219
+ [](./iframe.html?id=components-card--padding)
220
+
221
+ I’m a card with none padding
222
+
223
+ I’m a card with sm padding
224
+
225
+ I’m a card with md padding
226
+
227
+ I’m a card with lg padding
228
+
229
+ ```
230
+
231
+ <IressStack gap\="md"\>
232
+ <IressCard p\="none"\>
233
+ I’m a card with none padding </IressCard\>
234
+ <IressCard p\="sm"\>
235
+ I’m a card with sm padding </IressCard\>
236
+ <IressCard p\="md"\>
237
+ I’m a card with md padding </IressCard\>
238
+ <IressCard p\="lg"\>
239
+ I’m a card with lg padding </IressCard\>
240
+ </IressStack\>
241
+
242
+ ```
243
+
244
+ #### Props
245
+
246
+ | Name | Description | Default | Control |
247
+ | --- | --- | --- | --- |
248
+ | children |
249
+ Main body of the card
250
+
251
+ ReactNode
252
+
253
+
254
+
255
+ | \- |
256
+
257
+ "I'm a card"
258
+
259
+ |
260
+ | element |
261
+
262
+ Element type to render the Card as.
263
+
264
+ E
265
+
266
+
267
+
268
+ | \- | Set object |
269
+ | footer |
270
+
271
+ Section that sticks to the bottom of the card
272
+
273
+ ReactNode
274
+
275
+
276
+
277
+ | \- | Set object |
278
+ | heading |
279
+
280
+ Heading slot. Often used for a title or description.
281
+
282
+ ReactNode
283
+
284
+
285
+
286
+ | \- | Set object |
287
+ | media |
288
+
289
+ Section (often for an image, table or chart) that appears before the heading
290
+
291
+ ReactNode
292
+
293
+
294
+
295
+ | \- | Set object |
296
+ | prepend |
297
+
298
+ Slot to the left of card content.
299
+
300
+ ReactNode
301
+
302
+
303
+
304
+ | \- | Set object |
305
+ | selected |
306
+
307
+ When set to true, card appears selected.
308
+
309
+ boolean
310
+
311
+
312
+
313
+ | \- | Set boolean |
314
+ | topRight |
315
+
316
+ Slot positioned to the top right of the card, often used for an icon or action menu
317
+
318
+ ReactNode
319
+
320
+
321
+
322
+ | \- | Set object |
323
+
324
+ ### Stretch
325
+
326
+ The `stretch` prop can be used to stretch the card to fill its container.
327
+
328
+ [](./iframe.html?id=components-card--stretch)
329
+
330
+ I’m a stretched card
331
+
332
+ 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.
333
+
334
+ ```
335
+
336
+ <IressRow
337
+ gutter\="md"
338
+ verticalAlign\="stretch"
339
+ \>
340
+ <IressCol\>
341
+ <IressCard stretch\>
342
+ I’m a stretched card </IressCard\>
343
+ </IressCol\>
344
+ <IressCol\>
345
+ <IressCard\>
346
+ 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\>
347
+ </IressCol\>
348
+ </IressRow\>
349
+
350
+ ```
351
+
352
+ #### Props
353
+
354
+ | Name | Description | Default | Control |
355
+ | --- | --- | --- | --- |
356
+ | children |
357
+ Main body of the card
358
+
359
+ ReactNode
360
+
361
+
362
+
363
+ | \- |
364
+
365
+ "I'm a card"
366
+
367
+ |
368
+ | element |
369
+
370
+ Element type to render the Card as.
371
+
372
+ E
373
+
374
+
375
+
376
+ | \- | Set object |
377
+ | footer |
378
+
379
+ Section that sticks to the bottom of the card
380
+
381
+ ReactNode
382
+
383
+
384
+
385
+ | \- | Set object |
386
+ | heading |
387
+
388
+ Heading slot. Often used for a title or description.
389
+
390
+ ReactNode
391
+
392
+
393
+
394
+ | \- | Set object |
395
+ | media |
396
+
397
+ Section (often for an image, table or chart) that appears before the heading
398
+
399
+ ReactNode
400
+
401
+
402
+
403
+ | \- | Set object |
404
+ | prepend |
405
+
406
+ Slot to the left of card content.
407
+
408
+ ReactNode
409
+
410
+
411
+
412
+ | \- | Set object |
413
+ | selected |
414
+
415
+ When set to true, card appears selected.
416
+
417
+ boolean
418
+
419
+
420
+
421
+ | \- | Set boolean |
422
+ | topRight |
423
+
424
+ Slot positioned to the top right of the card, often used for an icon or action menu
425
+
426
+ ReactNode
427
+
428
+
429
+
430
+ | \- | Set object |
431
+
432
+ ### Selected
433
+
434
+ Setting the `selected` prop highlights the card, usually to allow selection in a list.
435
+
436
+ [](./iframe.html?id=components-card--selected)
437
+
438
+ I'm a selected card
439
+
440
+ ```
441
+
442
+ <IressCard selected\>
443
+ I'm a selected card
444
+ </IressCard\>
445
+
446
+ ```
447
+
448
+ #### Props
449
+
450
+ | Name | Description | Default | Control |
451
+ | --- | --- | --- | --- |
452
+ | children |
453
+ Main body of the card
454
+
455
+ ReactNode
456
+
457
+
458
+
459
+ | \- |
460
+
461
+ "I'm a selected card"
462
+
463
+ |
464
+ | element |
465
+
466
+ Element type to render the Card as.
467
+
468
+ E
469
+
470
+
471
+
472
+ | \- | Set object |
473
+ | footer |
474
+
475
+ Section that sticks to the bottom of the card
476
+
477
+ ReactNode
478
+
479
+
480
+
481
+ | \- | Set object |
482
+ | heading |
483
+
484
+ Heading slot. Often used for a title or description.
485
+
486
+ ReactNode
487
+
488
+
489
+
490
+ | \- | Set object |
491
+ | media |
492
+
493
+ Section (often for an image, table or chart) that appears before the heading
494
+
495
+ ReactNode
496
+
497
+
498
+
499
+ | \- | Set object |
500
+ | prepend |
501
+
502
+ Slot to the left of card content.
503
+
504
+ ReactNode
505
+
506
+
507
+
508
+ | \- | Set object |
509
+ | selected |
510
+
511
+ When set to true, card appears selected.
512
+
513
+ boolean
514
+
515
+
516
+
517
+ | \- | FalseTrue |
518
+ | topRight |
519
+
520
+ Slot positioned to the top right of the card, often used for an icon or action menu
521
+
522
+ ReactNode
523
+
524
+
525
+
526
+ | \- | Set object |
527
+
528
+ Render props (slots)
529
+ --------------------
530
+
531
+ 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.
532
+
533
+ However, please be diligent as the component you use may not fit withing the confines of the `IressCard` layout.
534
+
535
+ ### Prepend
536
+
537
+ Use the `prepend` prop to add content to the left side of the card.
538
+
539
+ [](./iframe.html?id=components-card-slots--prepend)
540
+
541
+ I'm a card using the prepend render prop
542
+
543
+ ```
544
+
545
+ <IressCard prepend\={<IressIcon name\="star" />}\>
546
+ I'm a card using the prepend render prop
547
+ </IressCard\>
548
+
549
+ ```
550
+
551
+ #### Props
552
+
553
+ | Name | Description | Default | Control |
554
+ | --- | --- | --- | --- |
555
+ | children |
556
+ Main body of the card
557
+
558
+ ReactNode
559
+
560
+
561
+
562
+ | \- |
563
+
564
+ "I'm a card using the prepend render prop"
565
+
566
+ |
567
+ | element |
568
+
569
+ Element type to render the Card as.
570
+
571
+ E
572
+
573
+
574
+
575
+ | \- | Set object |
576
+ | footer |
577
+
578
+ Section that sticks to the bottom of the card
579
+
580
+ ReactNode
581
+
582
+
583
+
584
+ | \- | Set object |
585
+ | heading |
586
+
587
+ Heading slot. Often used for a title or description.
588
+
589
+ ReactNode
590
+
591
+
592
+
593
+ | \- | Set object |
594
+ | media |
595
+
596
+ Section (often for an image, table or chart) that appears before the heading
597
+
598
+ ReactNode
599
+
600
+
601
+
602
+ | \- | Set object |
603
+ | prepend |
604
+
605
+ Slot to the left of card content.
606
+
607
+ ReactNode
608
+
609
+
610
+
611
+ | \- |
612
+
613
+ RAW
614
+
615
+ prepend :
616
+
617
+ {
618
+
619
+ * $$typeof : Symbol(react.transitional.element)
620
+ * type : ({ className, fixedWidth, flip, name, rotate, screenreaderText, set = "fal", spin, ...restProps }) => { const prefix = "fa-"; const classes = icon({ flip, rotate, spin }); return /\* @\_\_PURE\_\_ \*/ jsxDEV( styled.span, { role: "img", className: cx( classes, GlobalCSSClass.Icon, set, \`${prefix}${name}\`, fixedWidth && "fa-fw", className ), "aria-hidden": !screenreaderText && "true", "aria-label": screenreaderText, ...restProps }, void 0, false, { fileName: "/home/runner/work/design-system/design-system/packages/components/src/components/Icon/Icon.tsx", lineNumber: 67, columnNumber: 5 }, this ); }
621
+ * key : null
622
+ * props :
623
+
624
+ {...} 1 key
625
+
626
+ * \_owner : null
627
+ * \_store :
628
+
629
+ {...} 0 keys
630
+
631
+
632
+ }
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+ |
641
+ | selected |
642
+
643
+ When set to true, card appears selected.
644
+
645
+ boolean
646
+
647
+
648
+
649
+ | \- | Set boolean |
650
+ | topRight |
651
+
652
+ Slot positioned to the top right of the card, often used for an icon or action menu
653
+
654
+ ReactNode
655
+
656
+
657
+
658
+ | \- | Set object |
659
+
660
+ ### Top Right
661
+
662
+ 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.
663
+
664
+ [](./iframe.html?id=components-card-slots--top-right)
665
+
666
+ More actions in here
667
+
668
+ I'm a card using the topRight render prop
669
+
670
+ ```
671
+
672
+ <IressCard topRight\={<IressPopover activator\={<IressButton mode\="tertiary" textStyle\="typography.body.lg"\><IressIcon name\="ellipsis-v" /></IressButton\>} align\="bottom-end"\><IressPanel\>More actions in here</IressPanel\></IressPopover\>}\>
673
+ I'm a card using the topRight render prop
674
+ </IressCard\>
675
+
676
+ ```
677
+
678
+ #### Props
679
+
680
+ | Name | Description | Default | Control |
681
+ | --- | --- | --- | --- |
682
+ | children |
683
+ Main body of the card
684
+
685
+ ReactNode
686
+
687
+
688
+
689
+ | \- |
690
+
691
+ "I'm a card using the topRight render prop"
692
+
693
+ |
694
+ | element |
695
+
696
+ Element type to render the Card as.
697
+
698
+ E
699
+
700
+
701
+
702
+ | \- | Set object |
703
+ | footer |
704
+
705
+ Section that sticks to the bottom of the card
706
+
707
+ ReactNode
708
+
709
+
710
+
711
+ | \- | Set object |
712
+ | heading |
713
+
714
+ Heading slot. Often used for a title or description.
715
+
716
+ ReactNode
717
+
718
+
719
+
720
+ | \- | Set object |
721
+ | media |
722
+
723
+ Section (often for an image, table or chart) that appears before the heading
724
+
725
+ ReactNode
726
+
727
+
728
+
729
+ | \- | Set object |
730
+ | prepend |
731
+
732
+ Slot to the left of card content.
733
+
734
+ ReactNode
735
+
736
+
737
+
738
+ | \- | Set object |
739
+ | selected |
740
+
741
+ When set to true, card appears selected.
742
+
743
+ boolean
744
+
745
+
746
+
747
+ | \- | Set boolean |
748
+ | topRight |
749
+
750
+ Slot positioned to the top right of the card, often used for an icon or action menu
751
+
752
+ ReactNode
753
+
754
+
755
+
756
+ | \- |
757
+
758
+ RAW
759
+
760
+ topRight :
761
+
762
+ {
763
+
764
+ * $$typeof : Symbol(react.transitional.element)
765
+ * type :
766
+
767
+ {...} 3 keys
768
+
769
+ * key : null
770
+ * props :
771
+
772
+ {...} 3 keys
773
+
774
+ * \_owner : null
775
+ * \_store :
776
+
777
+ {...} 0 keys
778
+
779
+
780
+ }
781
+
782
+
783
+
784
+
785
+
786
+
787
+
788
+ |
789
+
790
+ ### Heading
791
+
792
+ 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.
793
+
794
+ **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.
795
+
796
+ [](./iframe.html?id=components-card-slots--heading)
797
+
798
+ Welcome to Iress!
799
+ -----------------
800
+
801
+ I'm a card using the heading render prop
802
+
803
+ ```
804
+
805
+ <IressCard heading\={<h2\>Welcome to Iress!</h2\>}\>
806
+ I'm a card using the heading render prop
807
+ </IressCard\>
808
+
809
+ ```
810
+
811
+ #### Props
812
+
813
+ | Name | Description | Default | Control |
814
+ | --- | --- | --- | --- |
815
+ | children |
816
+ Main body of the card
817
+
818
+ ReactNode
819
+
820
+
821
+
822
+ | \- |
823
+
824
+ "I'm a card using the heading render prop"
825
+
826
+ |
827
+ | element |
828
+
829
+ Element type to render the Card as.
830
+
831
+ E
832
+
833
+
834
+
835
+ | \- | Set object |
836
+ | footer |
837
+
838
+ Section that sticks to the bottom of the card
839
+
840
+ ReactNode
841
+
842
+
843
+
844
+ | \- | Set object |
845
+ | heading |
846
+
847
+ Heading slot. Often used for a title or description.
848
+
849
+ ReactNode
850
+
851
+
852
+
853
+ | \- |
854
+
855
+ RAW
856
+
857
+ heading :
858
+
859
+ {
860
+
861
+ * $$typeof : Symbol(react.transitional.element)
862
+ * type : "h2"
863
+ * key : null
864
+ * props :
865
+
866
+ {...} 1 key
867
+
868
+ * \_owner : null
869
+ * \_store :
870
+
871
+ {...} 0 keys
872
+
873
+
874
+ }
875
+
876
+
877
+
878
+
879
+
880
+
881
+
882
+ |
883
+ | media |
884
+
885
+ Section (often for an image, table or chart) that appears before the heading
886
+
887
+ ReactNode
888
+
889
+
890
+
891
+ | \- | Set object |
892
+ | prepend |
893
+
894
+ Slot to the left of card content.
895
+
896
+ ReactNode
897
+
898
+
899
+
900
+ | \- | Set object |
901
+ | selected |
902
+
903
+ When set to true, card appears selected.
904
+
905
+ boolean
906
+
907
+
908
+
909
+ | \- | Set boolean |
910
+ | topRight |
911
+
912
+ Slot positioned to the top right of the card, often used for an icon or action menu
913
+
914
+ ReactNode
915
+
916
+
917
+
918
+ | \- | Set object |
919
+
920
+ ### Media
921
+
922
+ 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.
923
+
924
+ [](./iframe.html?id=components-card-slots--media)
925
+
926
+ ![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)
927
+
928
+ I'm a card using the media render prop
929
+
930
+ ```
931
+
932
+ <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"/>}\>
933
+ I'm a card using the media render prop
934
+ </IressCard\>
935
+
936
+ ```
937
+
938
+ #### Props
939
+
940
+ | Name | Description | Default | Control |
941
+ | --- | --- | --- | --- |
942
+ | children |
943
+ Main body of the card
944
+
945
+ ReactNode
946
+
947
+
948
+
949
+ | \- |
950
+
951
+ "I'm a card using the media render prop"
952
+
953
+ |
954
+ | element |
955
+
956
+ Element type to render the Card as.
957
+
958
+ E
959
+
960
+
961
+
962
+ | \- | Set object |
963
+ | footer |
964
+
965
+ Section that sticks to the bottom of the card
966
+
967
+ ReactNode
968
+
969
+
970
+
971
+ | \- | Set object |
972
+ | heading |
973
+
974
+ Heading slot. Often used for a title or description.
975
+
976
+ ReactNode
977
+
978
+
979
+
980
+ | \- | Set object |
981
+ | media |
982
+
983
+ Section (often for an image, table or chart) that appears before the heading
984
+
985
+ ReactNode
986
+
987
+
988
+
989
+ | \- |
990
+
991
+ RAW
992
+
993
+ media :
994
+
995
+ {
996
+
997
+ * $$typeof : Symbol(react.transitional.element)
998
+ * type : "img"
999
+ * key : null
1000
+ * props :
1001
+
1002
+ {...} 3 keys
1003
+
1004
+ * \_owner : null
1005
+ * \_store :
1006
+
1007
+ {...} 0 keys
1008
+
1009
+
1010
+ }
1011
+
1012
+
1013
+
1014
+
1015
+
1016
+
1017
+
1018
+ |
1019
+ | prepend |
1020
+
1021
+ Slot to the left of card content.
1022
+
1023
+ ReactNode
1024
+
1025
+
1026
+
1027
+ | \- | Set object |
1028
+ | selected |
1029
+
1030
+ When set to true, card appears selected.
1031
+
1032
+ boolean
1033
+
1034
+
1035
+
1036
+ | \- | Set boolean |
1037
+ | topRight |
1038
+
1039
+ Slot positioned to the top right of the card, often used for an icon or action menu
1040
+
1041
+ ReactNode
1042
+
1043
+
1044
+
1045
+ | \- | Set object |
1046
+
1047
+ ### Content
1048
+
1049
+ 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.
1050
+
1051
+ [](./iframe.html?id=components-card-slots--content)
1052
+
1053
+ Find out all the onboarding material you need [with this easy guide](https://iress.com).
1054
+
1055
+ ```
1056
+
1057
+ <IressCard\>
1058
+ <IressText\>
1059
+ Find out all the onboarding material you need{' '}
1060
+ <a href\="https://iress.com"\>
1061
+ with this easy guide </a\>
1062
+ . </IressText\>
1063
+ </IressCard\>
1064
+
1065
+ ```
1066
+
1067
+ #### Props
1068
+
1069
+ | Name | Description | Default | Control |
1070
+ | --- | --- | --- | --- |
1071
+ | children |
1072
+ Main body of the card
1073
+
1074
+ ReactNode
1075
+
1076
+
1077
+
1078
+ | \- |
1079
+
1080
+ RAW
1081
+
1082
+ children :
1083
+
1084
+ {
1085
+
1086
+ * $$typeof : Symbol(react.transitional.element)
1087
+ * type : ({ className, ...restProps }) => { \_s(); const Component = useMemo( () => styled(restProps.element ?? "div", text), \[restProps.element\] ); return /\* @\_\_PURE\_\_ \*/ jsxDEV( Component, { ...restProps, className: cx(className, GlobalCSSClass.Text) }, void 0, false, { fileName: "/home/runner/work/design-system/design-system/packages/components/src/components/Text/Text.tsx", lineNumber: 46, columnNumber: 5 }, this ); }
1088
+ * key : null
1089
+ * props :
1090
+
1091
+ {...} 1 key
1092
+
1093
+ * \_owner : null
1094
+ * \_store :
1095
+
1096
+ {...} 0 keys
1097
+
1098
+
1099
+ }
1100
+
1101
+
1102
+
1103
+
1104
+
1105
+
1106
+
1107
+ |
1108
+ | element |
1109
+
1110
+ Element type to render the Card as.
1111
+
1112
+ E
1113
+
1114
+
1115
+
1116
+ | \- | Set object |
1117
+ | footer |
1118
+
1119
+ Section that sticks to the bottom of the card
1120
+
1121
+ ReactNode
1122
+
1123
+
1124
+
1125
+ | \- | Set object |
1126
+ | heading |
1127
+
1128
+ Heading slot. Often used for a title or description.
1129
+
1130
+ ReactNode
1131
+
1132
+
1133
+
1134
+ | \- | Set object |
1135
+ | media |
1136
+
1137
+ Section (often for an image, table or chart) that appears before the heading
1138
+
1139
+ ReactNode
1140
+
1141
+
1142
+
1143
+ | \- | Set object |
1144
+ | prepend |
1145
+
1146
+ Slot to the left of card content.
1147
+
1148
+ ReactNode
1149
+
1150
+
1151
+
1152
+ | \- | Set object |
1153
+ | selected |
1154
+
1155
+ When set to true, card appears selected.
1156
+
1157
+ boolean
1158
+
1159
+
1160
+
1161
+ | \- | Set boolean |
1162
+ | topRight |
1163
+
1164
+ Slot positioned to the top right of the card, often used for an icon or action menu
1165
+
1166
+ ReactNode
1167
+
1168
+
1169
+
1170
+ | \- | Set object |
1171
+
1172
+ ### Footer
1173
+
1174
+ 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.
1175
+
1176
+ [](./iframe.html?id=components-card-slots--footer)
1177
+
1178
+ I'm a card using the footer render prop
1179
+
1180
+ #new-starter#first-day
1181
+
1182
+ NEW
1183
+
1184
+ ```
1185
+
1186
+ <IressCard footer\={<IressInline gap\="sm" horizontalAlign\="between"\><IressInline gap\="sm"\><IressBadge pill\>#new-starter</IressBadge\><IressBadge pill\>#first-day</IressBadge\></IressInline\><IressBadge mode\="success"\>NEW</IressBadge\></IressInline\>}\>
1187
+ I'm a card using the footer render prop
1188
+ </IressCard\>
1189
+
1190
+ ```
1191
+
1192
+ #### Props
1193
+
1194
+ | Name | Description | Default | Control |
1195
+ | --- | --- | --- | --- |
1196
+ | children |
1197
+ Main body of the card
1198
+
1199
+ ReactNode
1200
+
1201
+
1202
+
1203
+ | \- |
1204
+
1205
+ "I'm a card using the footer render prop"
1206
+
1207
+ |
1208
+ | element |
1209
+
1210
+ Element type to render the Card as.
1211
+
1212
+ E
1213
+
1214
+
1215
+
1216
+ | \- | Set object |
1217
+ | footer |
1218
+
1219
+ Section that sticks to the bottom of the card
1220
+
1221
+ ReactNode
1222
+
1223
+
1224
+
1225
+ | \- |
1226
+
1227
+ RAW
1228
+
1229
+ footer :
1230
+
1231
+ {
1232
+
1233
+ * $$typeof : Symbol(react.transitional.element)
1234
+ * type : ({ className, ...restProps }) => /\* @\_\_PURE\_\_ \*/ jsxDEV(Component, { ...restProps, className: cx(className, GlobalCSSClass.Inline) }, void 0, false, { fileName: "/home/runner/work/design-system/design-system/packages/components/src/components/Inline/Inline.tsx", lineNumber: 51, columnNumber: 1 }, this)
1235
+ * key : null
1236
+ * props :
1237
+
1238
+ {...} 3 keys
1239
+
1240
+ * \_owner : null
1241
+ * \_store :
1242
+
1243
+ {...} 0 keys
1244
+
1245
+
1246
+ }
1247
+
1248
+
1249
+
1250
+
1251
+
1252
+
1253
+
1254
+ |
1255
+ | heading |
1256
+
1257
+ Heading slot. Often used for a title or description.
1258
+
1259
+ ReactNode
1260
+
1261
+
1262
+
1263
+ | \- | Set object |
1264
+ | media |
1265
+
1266
+ Section (often for an image, table or chart) that appears before the heading
1267
+
1268
+ ReactNode
1269
+
1270
+
1271
+
1272
+ | \- | Set object |
1273
+ | prepend |
1274
+
1275
+ Slot to the left of card content.
1276
+
1277
+ ReactNode
1278
+
1279
+
1280
+
1281
+ | \- | Set object |
1282
+ | selected |
1283
+
1284
+ When set to true, card appears selected.
1285
+
1286
+ boolean
1287
+
1288
+
1289
+
1290
+ | \- | Set boolean |
1291
+ | topRight |
1292
+
1293
+ Slot positioned to the top right of the card, often used for an icon or action menu
1294
+
1295
+ ReactNode
1296
+
1297
+
1298
+
1299
+ | \- | Set object |
1300
+
1301
+ ### All slots
1302
+
1303
+ You can use all the slots together to create a custom card layout.
1304
+
1305
+ [](./iframe.html?id=components-card-slots--all-slots)
1306
+
1307
+ prepend
1308
+
1309
+ media
1310
+
1311
+ heading
1312
+
1313
+ topRight
1314
+
1315
+ children
1316
+
1317
+ footer
1318
+
1319
+ * * *
1320
+
1321
+ More actions in here
1322
+
1323
+ ![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)
1324
+
1325
+ Welcome to Iress!
1326
+ -----------------
1327
+
1328
+ Find out all the onboarding material you need [with this easy guide](https://iress.com).
1329
+
1330
+ #new-starter#first-day
1331
+
1332
+ NEW
1333
+
1334
+ More actions in here
1335
+
1336
+ ![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)
1337
+
1338
+ Welcome to Iress!
1339
+ -----------------
1340
+
1341
+ Find out all the onboarding material you need [with this easy guide](https://iress.com).
1342
+
1343
+ #new-starter#first-day
1344
+
1345
+ NEW
1346
+
1347
+ More actions in here
1348
+
1349
+ ![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)
1350
+
1351
+ Welcome to Iress!
1352
+ -----------------
1353
+
1354
+ Find out all the onboarding material you need [with this easy guide](https://iress.com).
1355
+
1356
+ #new-starter#first-day
1357
+
1358
+ NEW
1359
+
1360
+ ```
1361
+
1362
+ export const CardAllSlots \= () \=> {
1363
+ const \[show, setShow\] \= useState({
1364
+ children: true,
1365
+ prepend: false,
1366
+ media: true,
1367
+ heading: true,
1368
+ topRight: true,
1369
+ footer: true,
1370
+ });
1371
+ const filteredArgs \= Object.fromEntries(
1372
+ Object.entries(supportedCardSlots).filter(
1373
+ (\[key\]) \=> show\[key as SupportedCardSlots\] || !(key in show),
1374
+ ),
1375
+ );
1376
+ return (
1377
+ <IressStack maxWidth\="container.lg" gap\="md" mx\="auto"\>
1378
+ <IressInline gap\="md"\>
1379
+ {SUPPORTED\_CARD\_SLOTS.map((slot) \=> (
1380
+ <IressToggle
1381
+ key\={slot}
1382
+ checked\={show\[slot as never\]}
1383
+ onChange\={(checked) \=> {
1384
+ setShow({ ...show, \[slot\]: checked });
1385
+ }}
1386
+ \>
1387
+ {slot}
1388
+ </IressToggle\>
1389
+ ))}
1390
+ </IressInline\>
1391
+ <IressDivider />
1392
+ <IressRow gutter\="md"\>
1393
+ <IressCol\>
1394
+ <IressCard {...filteredArgs} />
1395
+ </IressCol\>
1396
+ <IressCol\>
1397
+ <IressCard {...filteredArgs} />
1398
+ </IressCol\>
1399
+ <IressCol\>
1400
+ <IressCard {...filteredArgs} />
1401
+ </IressCol\>
1402
+ </IressRow\>
1403
+ </IressStack\>
1404
+ );
1405
+ };
1406
+
1407
+ ```
1408
+
1409
+ #### Props
1410
+
1411
+ | Name | Description | Default | Control |
1412
+ | --- | --- | --- | --- |
1413
+ | children |
1414
+ Main body of the card
1415
+
1416
+ ReactNode
1417
+
1418
+
1419
+
1420
+ | \- | \- |
1421
+ | element |
1422
+
1423
+ Element type to render the Card as.
1424
+
1425
+ E
1426
+
1427
+
1428
+
1429
+ | \- | Set object |
1430
+ | footer |
1431
+
1432
+ Section that sticks to the bottom of the card
1433
+
1434
+ ReactNode
1435
+
1436
+
1437
+
1438
+ | \- | \- |
1439
+ | heading |
1440
+
1441
+ Heading slot. Often used for a title or description.
1442
+
1443
+ ReactNode
1444
+
1445
+
1446
+
1447
+ | \- | \- |
1448
+ | media |
1449
+
1450
+ Section (often for an image, table or chart) that appears before the heading
1451
+
1452
+ ReactNode
1453
+
1454
+
1455
+
1456
+ | \- | \- |
1457
+ | prepend |
1458
+
1459
+ Slot to the left of card content.
1460
+
1461
+ ReactNode
1462
+
1463
+
1464
+
1465
+ | \- | \- |
1466
+ | selected |
1467
+
1468
+ When set to true, card appears selected.
1469
+
1470
+ boolean
1471
+
1472
+
1473
+
1474
+ | \- | Set boolean |
1475
+ | stretch |
1476
+
1477
+ boolean
1478
+
1479
+
1480
+
1481
+ | \- | FalseTrue |
1482
+ | topRight |
1483
+
1484
+ Slot positioned to the top right of the card, often used for an icon or action menu
1485
+
1486
+ ReactNode
1487
+
1488
+
1489
+
1490
+ | \- | \- |
1491
+
1492
+ Clickable cards
1493
+ ---------------
1494
+
1495
+ Note: The `clickable` prop has been deprecated in favour of using component variations, or the `onClick` prop.
1496
+
1497
+ ### Heading only
1498
+
1499
+ 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.
1500
+
1501
+ [](./iframe.html?id=components-card-clickable--heading-only)
1502
+
1503
+ [Clickable heading](https://iress.com)
1504
+ --------------------------------------
1505
+
1506
+ I'm a card with a clickable heading. NEVER use me when the whole card is clickable.
1507
+
1508
+ ```
1509
+
1510
+ <IressCard heading\={<h2\><a href\="https://iress.com"\>Clickable heading</a\></h2\>}\>
1511
+ I'm a card with a clickable heading. NEVER use me when the whole card is clickable.
1512
+ </IressCard\>
1513
+
1514
+ ```
1515
+
1516
+ #### Props
1517
+
1518
+ | Name | Description | Default | Control |
1519
+ | --- | --- | --- | --- |
1520
+ | children |
1521
+ Main body of the card
1522
+
1523
+ ReactNode
1524
+
1525
+
1526
+
1527
+ | \- |
1528
+
1529
+ "I'm a card with a clickable heading. NEVER use me when the whole card is clickable."
1530
+
1531
+ |
1532
+ | element |
1533
+
1534
+ Element type to render the Card as.
1535
+
1536
+ E
1537
+
1538
+
1539
+
1540
+ | \- | Set object |
1541
+ | footer |
1542
+
1543
+ Section that sticks to the bottom of the card
1544
+
1545
+ ReactNode
1546
+
1547
+
1548
+
1549
+ | \- | Set object |
1550
+ | heading |
1551
+
1552
+ Heading slot. Often used for a title or description.
1553
+
1554
+ ReactNode
1555
+
1556
+
1557
+
1558
+ | \- |
1559
+
1560
+ RAW
1561
+
1562
+ heading :
1563
+
1564
+ {
1565
+
1566
+ * $$typeof : Symbol(react.transitional.element)
1567
+ * type : "h2"
1568
+ * key : null
1569
+ * props :
1570
+
1571
+ {...} 1 key
1572
+
1573
+ * \_owner : null
1574
+ * \_store :
1575
+
1576
+ {...} 0 keys
1577
+
1578
+
1579
+ }
1580
+
1581
+
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+ |
1588
+ | media |
1589
+
1590
+ Section (often for an image, table or chart) that appears before the heading
1591
+
1592
+ ReactNode
1593
+
1594
+
1595
+
1596
+ | \- | Set object |
1597
+ | prepend |
1598
+
1599
+ Slot to the left of card content.
1600
+
1601
+ ReactNode
1602
+
1603
+
1604
+
1605
+ | \- | Set object |
1606
+ | selected |
1607
+
1608
+ When set to true, card appears selected.
1609
+
1610
+ boolean
1611
+
1612
+
1613
+
1614
+ | \- | Set boolean |
1615
+ | topRight |
1616
+
1617
+ Slot positioned to the top right of the card, often used for an icon or action menu
1618
+
1619
+ ReactNode
1620
+
1621
+
1622
+
1623
+ | \- | Set object |
1624
+
1625
+ ### Whole card
1626
+
1627
+ The whole card can be made clickable by passing an `onClick` prop. All the appropriate styling will be added as well.
1628
+
1629
+ 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.
1630
+
1631
+ [](./iframe.html?id=components-card-clickable--whole-card)
1632
+
1633
+ I am a card with an onClick handler. Click me to see what happens.
1634
+
1635
+ ```
1636
+
1637
+ <IressCard
1638
+ onClick\={() \=> alert("Card clicked")}
1639
+ onKeyDown\={() \=> alert("Key down on card (for keyboard users)")}
1640
+ role\="button"
1641
+ tabIndex\={0}
1642
+ \>
1643
+ I am a card with an onClick handler. Click me to see what happens.
1644
+ </IressCard\>
1645
+
1646
+ ```
1647
+
1648
+ #### Props
1649
+
1650
+ | Name | Description | Default | Control |
1651
+ | --- | --- | --- | --- |
1652
+ | children |
1653
+ Main body of the card
1654
+
1655
+ ReactNode
1656
+
1657
+
1658
+
1659
+ | \- |
1660
+
1661
+ "I am a card with an onClick handler. Click me to see what happens."
1662
+
1663
+ |
1664
+ | element |
1665
+
1666
+ Element type to render the Card as.
1667
+
1668
+ E
1669
+
1670
+
1671
+
1672
+ | \- | Set object |
1673
+ | footer |
1674
+
1675
+ Section that sticks to the bottom of the card
1676
+
1677
+ ReactNode
1678
+
1679
+
1680
+
1681
+ | \- | Set object |
1682
+ | heading |
1683
+
1684
+ Heading slot. Often used for a title or description.
1685
+
1686
+ ReactNode
1687
+
1688
+
1689
+
1690
+ | \- | Set object |
1691
+ | media |
1692
+
1693
+ Section (often for an image, table or chart) that appears before the heading
1694
+
1695
+ ReactNode
1696
+
1697
+
1698
+
1699
+ | \- | Set object |
1700
+ | onClick |
1701
+
1702
+ function
1703
+
1704
+
1705
+
1706
+ | \- | \- |
1707
+ | onKeyDown |
1708
+
1709
+ function
1710
+
1711
+
1712
+
1713
+ | \- | \- |
1714
+ | prepend |
1715
+
1716
+ Slot to the left of card content.
1717
+
1718
+ ReactNode
1719
+
1720
+
1721
+
1722
+ | \- | Set object |
1723
+ | role |
1724
+
1725
+ string
1726
+
1727
+
1728
+
1729
+ | \- | button |
1730
+ | selected |
1731
+
1732
+ When set to true, card appears selected.
1733
+
1734
+ boolean
1735
+
1736
+
1737
+
1738
+ | \- | Set boolean |
1739
+ | tabIndex |
1740
+
1741
+ number
1742
+
1743
+
1744
+
1745
+ | \- | |
1746
+ | topRight |
1747
+
1748
+ Slot positioned to the top right of the card, often used for an icon or action menu
1749
+
1750
+ ReactNode
1751
+
1752
+
1753
+
1754
+ | \- | Set object |
1755
+
1756
+ ### Links and Buttons
1757
+
1758
+ 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.
1759
+
1760
+ **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`.
1761
+
1762
+ [](./iframe.html?id=components-card-clickable--button-card)
1763
+
1764
+ I am a card with a button element
1765
+
1766
+ ```
1767
+
1768
+ <IressButtonCard
1769
+ onClick\={() \=> alert("Card clicked")}
1770
+ type\="button"
1771
+ \>
1772
+ I am a card with a button element
1773
+ </IressButtonCard\>
1774
+
1775
+ ```
1776
+
1777
+ #### Props
1778
+
1779
+ | Name | Description | Default | Control |
1780
+ | --- | --- | --- | --- |
1781
+ | children |
1782
+ Main body of the card
1783
+
1784
+ ReactNode
1785
+
1786
+
1787
+
1788
+ | \- | Set object |
1789
+ | element |
1790
+
1791
+ Element type to render the Card as.
1792
+
1793
+ E
1794
+
1795
+
1796
+
1797
+ | \- | Set object |
1798
+ | footer |
1799
+
1800
+ Section that sticks to the bottom of the card
1801
+
1802
+ ReactNode
1803
+
1804
+
1805
+
1806
+ | \- | Set object |
1807
+ | heading |
1808
+
1809
+ Heading slot. Often used for a title or description.
1810
+
1811
+ ReactNode
1812
+
1813
+
1814
+
1815
+ | \- | Set object |
1816
+ | media |
1817
+
1818
+ Section (often for an image, table or chart) that appears before the heading
1819
+
1820
+ ReactNode
1821
+
1822
+
1823
+
1824
+ | \- | Set object |
1825
+ | onClick |
1826
+
1827
+ function
1828
+
1829
+
1830
+
1831
+ | \- | \- |
1832
+ | prepend |
1833
+
1834
+ Slot to the left of card content.
1835
+
1836
+ ReactNode
1837
+
1838
+
1839
+
1840
+ | \- | Set object |
1841
+ | selected |
1842
+
1843
+ When set to true, card appears selected.
1844
+
1845
+ boolean
1846
+
1847
+
1848
+
1849
+ | \- | Set boolean |
1850
+ | topRight |
1851
+
1852
+ Slot positioned to the top right of the card, often used for an icon or action menu
1853
+
1854
+ ReactNode
1855
+
1856
+
1857
+
1858
+ | \- | Set object |
1859
+ | type |
1860
+
1861
+ string
1862
+
1863
+
1864
+
1865
+ | \- | button |
1866
+
1867
+ [](./iframe.html?id=components-card-clickable--link-card)
1868
+
1869
+ [I am a card with an anchor element](https://iress.com)
1870
+
1871
+ ```
1872
+
1873
+ <IressLinkCard
1874
+ href\="https://iress.com"
1875
+ target\="\_blank"
1876
+ \>
1877
+ I am a card with an anchor element
1878
+ </IressLinkCard\>
1879
+
1880
+ ```
1881
+
1882
+ #### Props
1883
+
1884
+ | Name | Description | Default | Control |
1885
+ | --- | --- | --- | --- |
1886
+ | children |
1887
+ Main body of the card
1888
+
1889
+ ReactNode
1890
+
1891
+
1892
+
1893
+ | \- | Set object |
1894
+ | element |
1895
+
1896
+ Element type to render the Card as.
1897
+
1898
+ E
1899
+
1900
+
1901
+
1902
+ | \- | Set object |
1903
+ | footer |
1904
+
1905
+ Section that sticks to the bottom of the card
1906
+
1907
+ ReactNode
1908
+
1909
+
1910
+
1911
+ | \- | Set object |
1912
+ | heading |
1913
+
1914
+ Heading slot. Often used for a title or description.
1915
+
1916
+ ReactNode
1917
+
1918
+
1919
+
1920
+ | \- | Set object |
1921
+ | href |
1922
+
1923
+ string
1924
+
1925
+
1926
+
1927
+ | \- | https://iress.com |
1928
+ | media |
1929
+
1930
+ Section (often for an image, table or chart) that appears before the heading
1931
+
1932
+ ReactNode
1933
+
1934
+
1935
+
1936
+ | \- | Set object |
1937
+ | prepend |
1938
+
1939
+ Slot to the left of card content.
1940
+
1941
+ ReactNode
1942
+
1943
+
1944
+
1945
+ | \- | Set object |
1946
+ | selected |
1947
+
1948
+ When set to true, card appears selected.
1949
+
1950
+ boolean
1951
+
1952
+
1953
+
1954
+ | \- | Set boolean |
1955
+ | target |
1956
+
1957
+ string
1958
+
1959
+
1960
+
1961
+ | \- | \_blank |
1962
+ | topRight |
1963
+
1964
+ Slot positioned to the top right of the card, often used for an icon or action menu
1965
+
1966
+ ReactNode
1967
+
1968
+
1969
+
1970
+ | \- | Set object |