@iress-oss/ids-mcp-server 5.15.0 → 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.
- package/generated/docs/components_components-alert-docs.md +492 -0
- package/generated/docs/components_components-autocomplete-docs.md +3485 -0
- package/generated/docs/{components-autocomplete-recipes-docs.md → components_components-autocomplete-recipes-docs.md} +32 -14
- package/generated/docs/{components-badge-docs.md → components_components-badge-docs.md} +222 -30
- package/generated/docs/components_components-button-docs.md +2078 -0
- package/generated/docs/components_components-button-recipes-docs.md +37 -0
- package/generated/docs/components_components-buttongroup-docs.md +1045 -0
- package/generated/docs/components_components-card-docs.md +2276 -0
- package/generated/docs/{components-card-recipes-docs.md → components_components-card-recipes-docs.md} +131 -14
- package/generated/docs/components_components-checkbox-docs.md +1054 -0
- package/generated/docs/{components-checkboxgroup-docs.md → components_components-checkboxgroup-docs.md} +1000 -81
- package/generated/docs/{components-checkboxgroup-recipes-docs.md → components_components-checkboxgroup-recipes-docs.md} +101 -11
- package/generated/docs/{components-col-docs.md → components_components-col-docs.md} +331 -58
- package/generated/docs/components_components-combobox-docs.md +3767 -0
- package/generated/docs/{components-container-docs.md → components_components-container-docs.md} +61 -24
- package/generated/docs/{components-divider-docs.md → components_components-divider-docs.md} +83 -24
- package/generated/docs/{components-expander-docs.md → components_components-expander-docs.md} +264 -33
- package/generated/docs/{components-field-docs.md → components_components-field-docs.md} +814 -120
- package/generated/docs/components_components-filter-docs.md +4080 -0
- package/generated/docs/{components-form-docs.md → components_components-form-docs.md} +1515 -353
- package/generated/docs/{components-form-recipes-docs.md → components_components-form-recipes-docs.md} +170 -54
- package/generated/docs/components_components-hide-docs.md +293 -0
- package/generated/docs/components_components-icon-docs.md +1337 -0
- package/generated/docs/{components-inline-docs.md → components_components-inline-docs.md} +462 -42
- package/generated/docs/components_components-input-docs.md +1468 -0
- package/generated/docs/components_components-input-recipes-docs.md +367 -0
- package/generated/docs/components_components-inputcurrency-docs.md +432 -0
- package/generated/docs/{components-inputcurrency-recipes-docs.md → components_components-inputcurrency-recipes-docs.md} +110 -17
- package/generated/docs/components_components-label-docs.md +323 -0
- package/generated/docs/components_components-menu-docs.md +2345 -0
- package/generated/docs/components_components-menu-menuitem-docs.md +633 -0
- package/generated/docs/{components-modal-docs.md → components_components-modal-docs.md} +1625 -232
- package/generated/docs/components_components-navbar-docs.md +1847 -0
- package/generated/docs/{components-navbar-recipes-docs.md → components_components-navbar-recipes-docs.md} +697 -39
- package/generated/docs/{components-panel-docs.md → components_components-panel-docs.md} +754 -57
- package/generated/docs/components_components-placeholder-docs.md +92 -0
- package/generated/docs/components_components-popover-docs.md +1641 -0
- package/generated/docs/{components-popover-recipes-docs.md → components_components-popover-recipes-docs.md} +347 -17
- package/generated/docs/components_components-progress-docs.md +115 -0
- package/generated/docs/{components-provider-docs.md → components_components-provider-docs.md} +41 -32
- package/generated/docs/components_components-radio-docs.md +491 -0
- package/generated/docs/{components-radiogroup-docs.md → components_components-radiogroup-docs.md} +943 -75
- package/generated/docs/components_components-readonly-docs.md +263 -0
- package/generated/docs/components_components-richselect-docs.md +6497 -0
- package/generated/docs/{components-row-docs.md → components_components-row-docs.md} +353 -43
- package/generated/docs/{components-select-docs.md → components_components-select-docs.md} +719 -61
- package/generated/docs/components_components-skeleton-docs.md +480 -0
- package/generated/docs/{components-skeleton-recipes-docs.md → components_components-skeleton-recipes-docs.md} +50 -10
- package/generated/docs/{components-skiplink-docs.md → components_components-skiplink-docs.md} +53 -14
- package/generated/docs/components_components-slideout-docs.md +2262 -0
- package/generated/docs/components_components-slider-docs.md +1276 -0
- package/generated/docs/components_components-spinner-docs.md +82 -0
- package/generated/docs/{components-stack-docs.md → components_components-stack-docs.md} +223 -40
- package/generated/docs/components_components-table-docs.md +3651 -0
- package/generated/docs/components_components-tabset-docs.md +772 -0
- package/generated/docs/components_components-tabset-tab-docs.md +262 -0
- package/generated/docs/components_components-tag-docs.md +259 -0
- package/generated/docs/{components-text-docs.md → components_components-text-docs.md} +491 -51
- package/generated/docs/{components-toaster-docs.md → components_components-toaster-docs.md} +181 -79
- package/generated/docs/components_components-toaster-toast-docs.md +634 -0
- package/generated/docs/components_components-toggle-docs.md +461 -0
- package/generated/docs/{components-tooltip-docs.md → components_components-tooltip-docs.md} +286 -41
- package/generated/docs/{components-validationmessage-docs.md → components_components-validationmessage-docs.md} +230 -61
- package/generated/docs/components_contact-us-docs.md +12 -0
- package/generated/docs/{foundations-accessibility-docs.md → components_foundations-accessibility-docs.md} +11 -21
- package/generated/docs/{foundations-colours-docs.md → components_foundations-colour-030-colours.md} +8 -15
- package/generated/docs/{foundations-consistency-docs.md → components_foundations-consistency-docs.md} +12 -20
- package/generated/docs/{foundations-content-docs.md → components_foundations-content-docs.md} +6 -11
- package/generated/docs/components_foundations-introduction-docs.md +15 -0
- package/generated/docs/{foundations-principles-docs.md → components_foundations-principles-docs.md} +14 -24
- package/generated/docs/components_foundations-typography-docs.md +608 -0
- package/generated/docs/{foundations-user-experience-docs.md → components_foundations-user-experience-docs.md} +16 -26
- package/generated/docs/{foundations-visual-design-docs.md → components_foundations-visual-design-docs.md} +10 -17
- package/generated/docs/{frequently-asked-questions-docs.md → components_frequently-asked-questions-docs.md} +14 -23
- package/generated/docs/components_get-started-develop-docs.md +84 -0
- package/generated/docs/components_get-started-using-storybook-docs.md +55 -0
- package/generated/docs/components_introduction-docs.md +15 -0
- package/generated/docs/{patterns-loading-docs.md → components_patterns-loading-docs.md} +711 -143
- package/generated/docs/components_resources-changelog-docs.md +4 -0
- package/generated/docs/{resources-code-katas-docs.md → components_resources-code-katas-docs.md} +5 -9
- package/generated/docs/{resources-migration-guides-from-v4-to-v5-docs.md → components_resources-migration-guides-from-v4-to-v5-docs.md} +54 -239
- package/generated/docs/{versions-docs.md → components_versions-docs.md} +5 -8
- package/generated/docs/guidelines.md +484 -200
- package/generated/docs/introduction-docs.md +19 -30
- package/package.json +41 -45
- package/generated/docs/components-alert-docs.md +0 -130
- package/generated/docs/components-autocomplete-docs.md +0 -754
- package/generated/docs/components-button-docs.md +0 -362
- package/generated/docs/components-button-recipes-docs.md +0 -76
- package/generated/docs/components-buttongroup-docs.md +0 -310
- package/generated/docs/components-card-docs.md +0 -494
- package/generated/docs/components-checkbox-docs.md +0 -193
- package/generated/docs/components-combobox-docs.md +0 -1016
- package/generated/docs/components-filter-docs.md +0 -1109
- package/generated/docs/components-hide-docs.md +0 -265
- package/generated/docs/components-icon-docs.md +0 -553
- package/generated/docs/components-input-docs.md +0 -335
- package/generated/docs/components-input-recipes-docs.md +0 -140
- package/generated/docs/components-inputcurrency-docs.md +0 -157
- package/generated/docs/components-label-docs.md +0 -135
- package/generated/docs/components-menu-docs.md +0 -704
- package/generated/docs/components-menu-menuitem-docs.md +0 -193
- package/generated/docs/components-navbar-docs.md +0 -291
- package/generated/docs/components-placeholder-docs.md +0 -27
- package/generated/docs/components-popover-docs.md +0 -464
- package/generated/docs/components-progress-docs.md +0 -104
- package/generated/docs/components-radio-docs.md +0 -107
- package/generated/docs/components-readonly-docs.md +0 -89
- package/generated/docs/components-richselect-docs.md +0 -2433
- package/generated/docs/components-skeleton-docs.md +0 -214
- package/generated/docs/components-slideout-docs.md +0 -538
- package/generated/docs/components-slider-docs.md +0 -346
- package/generated/docs/components-spinner-docs.md +0 -59
- package/generated/docs/components-table-ag-grid-docs.md +0 -1074
- package/generated/docs/components-table-docs.md +0 -1305
- package/generated/docs/components-tabset-docs.md +0 -341
- package/generated/docs/components-tabset-tab-docs.md +0 -86
- package/generated/docs/components-tag-docs.md +0 -115
- package/generated/docs/components-toaster-toast-docs.md +0 -157
- package/generated/docs/components-toggle-docs.md +0 -158
- package/generated/docs/contact-us-docs.md +0 -27
- package/generated/docs/extensions-editor-docs.md +0 -288
- package/generated/docs/extensions-editor-recipes-docs.md +0 -39
- package/generated/docs/foundations-introduction-docs.md +0 -17
- package/generated/docs/foundations-typography-docs.md +0 -191
- package/generated/docs/get-started-develop-docs.md +0 -209
- package/generated/docs/get-started-using-storybook-docs.md +0 -68
- package/generated/docs/resources-changelog-docs.md +0 -6
- package/generated/docs/themes-available-themes-docs.md +0 -66
- package/generated/docs/themes-introduction-docs.md +0 -121
- package/generated/docs/themes-tokens-docs.md +0 -1200
- /package/{LICENSE.txt → LICENSE} +0 -0
|
@@ -1,24 +1,26 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
Recipes
|
|
2
|
+
=======
|
|
3
3
|
|
|
4
4
|
Under construction
|
|
5
5
|
------------------
|
|
6
6
|
|
|
7
7
|
This documentation is still under construction. If you have any questions, please reach out to the design system team.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
9
|
+
Compose functions
|
|
10
|
+
-----------------
|
|
11
11
|
|
|
12
12
|
Beneath the surface, the `IressCard` component uses a compose helper to manage its styling. These helpers are exposed as `composeIDSCard` and `composeIDSCardSlots` and can be used to create custom cards.
|
|
13
13
|
|
|
14
14
|
They accept a subset of `IressCardProps`. They also accept an optional second argument if you want to override the default styles with your own CSS module, or other `style` object (eg. CSS-in-JS).
|
|
15
15
|
|
|
16
|
-
###
|
|
16
|
+
### Use cases
|
|
17
17
|
|
|
18
18
|
1. You are using a third-party routing library with its own `Link` component and want to use it as a clickable card. This is similar to `IressButtonCard` and `IressLinkCard`.
|
|
19
19
|
2. You need a different base component to meet your requirements, such as `<article />` when displaying on a news page.
|
|
20
20
|
3. You need to add some additional styling to the internals of the card, such as a custom footer or a custom image.
|
|
21
21
|
|
|
22
|
+
[](./iframe.html?id=components-card-recipes--compose-ids-card)
|
|
23
|
+
|
|
22
24
|
Article mark-up, with custom classes for border
|
|
23
25
|
-----------------------------------------------
|
|
24
26
|
|
|
@@ -35,19 +37,17 @@ Children (default slot)
|
|
|
35
37
|
|
|
36
38
|
Footer
|
|
37
39
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
\[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; }
|
|
40
|
+
```
|
|
41
41
|
|
|
42
42
|
import {
|
|
43
43
|
CardSlotClass,
|
|
44
44
|
composeIDSCard,
|
|
45
45
|
composeIDSCardSlots,
|
|
46
|
-
IressCardProps,
|
|
46
|
+
type IressCardProps,
|
|
47
47
|
IressStack,
|
|
48
48
|
IressText,
|
|
49
49
|
} from '@iress-oss/ids-components';
|
|
50
|
-
import styles from '
|
|
50
|
+
import styles from '~storybook/styles.module.scss';
|
|
51
51
|
export const CardUsingHook \= () \=> {
|
|
52
52
|
const cardProps \= composeIDSCard({
|
|
53
53
|
prepend: 'Prepend',
|
|
@@ -81,9 +81,126 @@ export const CardUsingHook \= () \=> {
|
|
|
81
81
|
);
|
|
82
82
|
};
|
|
83
83
|
|
|
84
|
-
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
#### Props
|
|
87
|
+
|
|
88
|
+
| Name | Description | Default | Control |
|
|
89
|
+
| --- | --- | --- | --- |
|
|
90
|
+
| children |
|
|
91
|
+
Main body of the card
|
|
92
|
+
|
|
93
|
+
ReactReactNode
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
| \- |
|
|
98
|
+
|
|
99
|
+
"Children (default slot)"
|
|
100
|
+
|
|
101
|
+
|
|
|
102
|
+
| footer |
|
|
103
|
+
|
|
104
|
+
Section that sticks to the bottom of the card
|
|
105
|
+
|
|
106
|
+
ReactReactNode
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
| \- |
|
|
111
|
+
|
|
112
|
+
"Footer"
|
|
113
|
+
|
|
114
|
+
|
|
|
115
|
+
| heading |
|
|
116
|
+
|
|
117
|
+
Heading slot. Often used for a title or description.
|
|
118
|
+
|
|
119
|
+
ReactReactNode
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
| \- |
|
|
124
|
+
|
|
125
|
+
"Heading"
|
|
126
|
+
|
|
127
|
+
|
|
|
128
|
+
| headingLevel |
|
|
129
|
+
|
|
130
|
+
Level of heading for markup, to ensure correct hierarchy (H2 - H6).
|
|
131
|
+
|
|
132
|
+
HeadingLevel
|
|
133
|
+
|
|
134
|
+
<table class="css-3nr4py"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `heading` instead.</td></tr></tbody></table>
|
|
135
|
+
|
|
136
|
+
|
|
|
137
|
+
|
|
138
|
+
HeadingLevel.H2
|
|
139
|
+
|
|
140
|
+
| Set object |
|
|
141
|
+
| headingText |
|
|
142
|
+
|
|
143
|
+
Text to be displayed in the card heading in the card header.
|
|
144
|
+
|
|
145
|
+
string
|
|
146
|
+
|
|
147
|
+
<table class="css-3nr4py"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `heading` instead.</td></tr></tbody></table>
|
|
148
|
+
|
|
149
|
+
| \- | Set string |
|
|
150
|
+
| media |
|
|
151
|
+
|
|
152
|
+
Section (often for an image, table or chart) that appears before the heading
|
|
153
|
+
|
|
154
|
+
ReactReactNode
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
| \- |
|
|
159
|
+
|
|
160
|
+
"Media"
|
|
161
|
+
|
|
162
|
+
|
|
|
163
|
+
| onClick |
|
|
164
|
+
|
|
165
|
+
When set, the card will be clickable and will apply the selected style
|
|
166
|
+
|
|
167
|
+
ReactMouseEventHandler
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
| \- |
|
|
172
|
+
|
|
173
|
+
|
|
|
174
|
+
| padding |
|
|
175
|
+
|
|
176
|
+
|
|
|
177
|
+
|
|
178
|
+
PaddingSize.Md
|
|
179
|
+
|
|
180
|
+
| Set object |
|
|
181
|
+
| prepend |
|
|
182
|
+
|
|
183
|
+
Slot to the left of card content.
|
|
184
|
+
|
|
185
|
+
ReactReactNode
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
| \- |
|
|
190
|
+
|
|
191
|
+
"Prepend"
|
|
192
|
+
|
|
193
|
+
|
|
|
194
|
+
| topRight |
|
|
195
|
+
|
|
196
|
+
Slot positioned to the top right of the card, often used for an icon or action menu
|
|
197
|
+
|
|
198
|
+
ReactReactNode
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
| \- |
|
|
85
203
|
|
|
86
|
-
|
|
204
|
+
"TopRight"
|
|
87
205
|
|
|
88
|
-
|
|
89
|
-
* [Use cases](#use-cases)
|
|
206
|
+
|
|