@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.
- 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} +1488 -358
- package/generated/docs/{components-form-recipes-docs.md → components_components-form-recipes-docs.md} +174 -64
- 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_components-provider-docs.md +114 -0
- 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} +224 -71
- 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 -2666
- 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 -48
- 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,19 +1,19 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
Field
|
|
2
|
+
=====
|
|
3
3
|
|
|
4
4
|
Overview
|
|
5
5
|
--------
|
|
6
6
|
|
|
7
7
|
The field component is used to place label, hint and error information around form controls.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
[](./iframe.html?id=components-field--default)
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
First name
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
```
|
|
14
14
|
|
|
15
15
|
<IressField label\="First name"\>
|
|
16
|
-
<
|
|
16
|
+
<ForwardedInput
|
|
17
17
|
id\="name"
|
|
18
18
|
name\="input1"
|
|
19
19
|
required
|
|
@@ -21,23 +21,60 @@ Hide code
|
|
|
21
21
|
/>
|
|
22
22
|
</IressField\>
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Props
|
|
27
|
+
-----
|
|
28
|
+
|
|
29
|
+
| Name | Description | Default | Control |
|
|
30
|
+
| --- | --- | --- | --- |
|
|
31
|
+
| children |
|
|
32
|
+
The form control this field is related to.
|
|
33
|
+
|
|
34
|
+
ReactReactNode
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
| \- | \- |
|
|
39
|
+
| label\* |
|
|
40
|
+
|
|
41
|
+
Text to be displayed in the label.
|
|
42
|
+
|
|
43
|
+
ReactNode
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
| \- |
|
|
25
48
|
|
|
26
|
-
|
|
27
|
-
---------------------
|
|
49
|
+
"First name"
|
|
28
50
|
|
|
29
|
-
|
|
51
|
+
|
|
|
52
|
+
| readOnly |
|
|
53
|
+
|
|
54
|
+
Renders the group in a read-only state (no asterisk symbol).
|
|
55
|
+
|
|
56
|
+
boolean
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
| \- | Set boolean |
|
|
61
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
62
|
+
|
|
63
|
+
Examples
|
|
64
|
+
--------
|
|
65
|
+
|
|
66
|
+
### Label
|
|
30
67
|
|
|
31
68
|
The `label` prop is required to describe the field.
|
|
32
69
|
|
|
33
|
-
|
|
70
|
+
[](./iframe.html?id=components-field--label)
|
|
34
71
|
|
|
35
|
-
|
|
72
|
+
Find your address
|
|
36
73
|
|
|
37
|
-
|
|
74
|
+
```
|
|
38
75
|
|
|
39
76
|
<IressField label\={<span\><IressIcon name\="home" />{' '}Find your address</span\>}\>
|
|
40
|
-
<
|
|
77
|
+
<ForwardedInput
|
|
41
78
|
id\="name"
|
|
42
79
|
name\="input1"
|
|
43
80
|
required
|
|
@@ -45,25 +82,57 @@ Hide code
|
|
|
45
82
|
/>
|
|
46
83
|
</IressField\>
|
|
47
84
|
|
|
48
|
-
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
#### Props
|
|
88
|
+
|
|
89
|
+
| Name | Description | Default | Control |
|
|
90
|
+
| --- | --- | --- | --- |
|
|
91
|
+
| children |
|
|
92
|
+
The form control this field is related to.
|
|
49
93
|
|
|
50
|
-
|
|
94
|
+
ReactReactNode
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
| \- | \- |
|
|
99
|
+
| label\* |
|
|
100
|
+
|
|
101
|
+
Text to be displayed in the label.
|
|
102
|
+
|
|
103
|
+
ReactNode
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
| \- | \- |
|
|
108
|
+
| readOnly |
|
|
109
|
+
|
|
110
|
+
Renders the group in a read-only state (no asterisk symbol).
|
|
111
|
+
|
|
112
|
+
boolean
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
| \- | Set boolean |
|
|
117
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
118
|
+
|
|
119
|
+
### Hint
|
|
51
120
|
|
|
52
121
|
Extra information on the field can be provided using the `hint` prop. It can accept any React node, so you can add your own custom mark up (eg. external links) to the hint text.
|
|
53
122
|
|
|
123
|
+
[](./iframe.html?id=components-field--hint)
|
|
124
|
+
|
|
54
125
|
Email address
|
|
55
126
|
|
|
56
127
|
For us to be able to contact you in the future
|
|
57
128
|
|
|
58
|
-
|
|
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; }
|
|
129
|
+
```
|
|
61
130
|
|
|
62
131
|
<IressField
|
|
63
132
|
hint\="For us to be able to contact you in the future"
|
|
64
133
|
label\="Email address"
|
|
65
134
|
\>
|
|
66
|
-
<
|
|
135
|
+
<ForwardedInput
|
|
67
136
|
id\="email"
|
|
68
137
|
name\="email"
|
|
69
138
|
required
|
|
@@ -71,13 +140,58 @@ Hide code
|
|
|
71
140
|
/>
|
|
72
141
|
</IressField\>
|
|
73
142
|
|
|
74
|
-
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
#### Props
|
|
146
|
+
|
|
147
|
+
| Name | Description | Default | Control |
|
|
148
|
+
| --- | --- | --- | --- |
|
|
149
|
+
| children |
|
|
150
|
+
The form control this field is related to.
|
|
151
|
+
|
|
152
|
+
ReactReactNode
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
| \- | \- |
|
|
157
|
+
| hint |
|
|
158
|
+
|
|
159
|
+
string
|
|
160
|
+
|
|
161
|
+
|
|
75
162
|
|
|
76
|
-
|
|
163
|
+
| \- | For us to be able to contact you in the future |
|
|
164
|
+
| label\* |
|
|
165
|
+
|
|
166
|
+
Text to be displayed in the label.
|
|
167
|
+
|
|
168
|
+
ReactNode
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
| \- |
|
|
173
|
+
|
|
174
|
+
"Email address"
|
|
175
|
+
|
|
176
|
+
|
|
|
177
|
+
| readOnly |
|
|
178
|
+
|
|
179
|
+
Renders the group in a read-only state (no asterisk symbol).
|
|
180
|
+
|
|
181
|
+
boolean
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
| \- | Set boolean |
|
|
186
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
187
|
+
|
|
188
|
+
### Error message
|
|
77
189
|
|
|
78
190
|
To display error messages associated with the field, you can use the `errorMessages` prop. This prop accepts an array of `ValidationMessageObj`, and will display each error message in a separate paragraph.
|
|
79
191
|
|
|
80
|
-
**Note:** `IressField` requires validation to be handled by the consumer. If you want out-of-the-box validation, use [`IressFormField` alongside `IressForm` instead](
|
|
192
|
+
**Note:** `IressField` requires validation to be handled by the consumer. If you want out-of-the-box validation, use [`IressFormField` alongside `IressForm` instead](/docs/components-form--docs#fields).
|
|
193
|
+
|
|
194
|
+
[](./iframe.html?id=components-field--error-message)
|
|
81
195
|
|
|
82
196
|
Error message
|
|
83
197
|
|
|
@@ -86,9 +200,7 @@ Error message
|
|
|
86
200
|
This field is required
|
|
87
201
|
|
|
88
202
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
\[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; }
|
|
203
|
+
```
|
|
92
204
|
|
|
93
205
|
<IressField
|
|
94
206
|
errorMessages\={\[
|
|
@@ -98,17 +210,80 @@ Hide code
|
|
|
98
210
|
\]}
|
|
99
211
|
label\="Error message"
|
|
100
212
|
\>
|
|
101
|
-
<
|
|
213
|
+
<ForwardedInput append={<IressButton data-testid\="show-password-icon" mode\="tertiary" prepend\={<IressIcon name\="fal fa-light fa-eye" screenreaderText\="Show" size\="sm" style\={{width: '18px'}}/>}/>}
|
|
102
214
|
id="name" name="name" required />
|
|
103
215
|
</IressField\>
|
|
104
216
|
|
|
105
|
-
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
#### Props
|
|
220
|
+
|
|
221
|
+
| Name | Description | Default | Control |
|
|
222
|
+
| --- | --- | --- | --- |
|
|
223
|
+
| children |
|
|
224
|
+
The form control this field is related to.
|
|
225
|
+
|
|
226
|
+
ReactReactNode
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
| \- | \- |
|
|
231
|
+
| errorMessages |
|
|
232
|
+
|
|
233
|
+
array
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
| \- |
|
|
106
238
|
|
|
107
|
-
|
|
239
|
+
RAW
|
|
240
|
+
|
|
241
|
+
* errorMessages :
|
|
242
|
+
|
|
243
|
+
\[
|
|
244
|
+
|
|
245
|
+
* 0 :
|
|
246
|
+
|
|
247
|
+
{...} 1 key
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
\]
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
|
256
|
+
| label\* |
|
|
257
|
+
|
|
258
|
+
Text to be displayed in the label.
|
|
259
|
+
|
|
260
|
+
ReactNode
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
| \- |
|
|
265
|
+
|
|
266
|
+
"Error message"
|
|
267
|
+
|
|
268
|
+
|
|
|
269
|
+
| readOnly |
|
|
270
|
+
|
|
271
|
+
Renders the group in a read-only state (no asterisk symbol).
|
|
272
|
+
|
|
273
|
+
boolean
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
| \- | Set boolean |
|
|
278
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
279
|
+
|
|
280
|
+
### Custom error
|
|
108
281
|
|
|
109
282
|
For more control over the formatting of the error, you can use the `error` prop. This prop accepts any React node, so you can add your own custom mark up (eg. icons) to the error message.
|
|
110
283
|
|
|
111
|
-
**Note:** `IressField` requires validation to be handled by the consumer. If you want out-of-the-box validation, use [`IressFormField` alongside `IressForm` instead](
|
|
284
|
+
**Note:** `IressField` requires validation to be handled by the consumer. If you want out-of-the-box validation, use [`IressFormField` alongside `IressForm` instead](/docs/components-form--docs#fields).
|
|
285
|
+
|
|
286
|
+
[](./iframe.html?id=components-field--custom-error)
|
|
112
287
|
|
|
113
288
|
Custom error
|
|
114
289
|
|
|
@@ -116,41 +291,111 @@ Error:
|
|
|
116
291
|
|
|
117
292
|
This is a custom error message
|
|
118
293
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
\[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; }
|
|
294
|
+
```
|
|
122
295
|
|
|
123
296
|
<IressField
|
|
124
297
|
error\={<IressValidationMessage\>This is a custom error message</IressValidationMessage\>}
|
|
125
298
|
label\="Custom error"
|
|
126
299
|
\>
|
|
127
|
-
<
|
|
300
|
+
<ForwardedInput
|
|
128
301
|
id\="name"
|
|
129
302
|
name\="name"
|
|
130
303
|
required
|
|
131
304
|
/>
|
|
132
305
|
</IressField\>
|
|
133
306
|
|
|
134
|
-
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
#### Props
|
|
310
|
+
|
|
311
|
+
| Name | Description | Default | Control |
|
|
312
|
+
| --- | --- | --- | --- |
|
|
313
|
+
| children |
|
|
314
|
+
The form control this field is related to.
|
|
135
315
|
|
|
136
|
-
|
|
316
|
+
ReactReactNode
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
| \- | \- |
|
|
321
|
+
| error |
|
|
322
|
+
|
|
323
|
+
object
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
| \- |
|
|
328
|
+
|
|
329
|
+
RAW
|
|
330
|
+
|
|
331
|
+
error :
|
|
332
|
+
|
|
333
|
+
{
|
|
334
|
+
|
|
335
|
+
* $$typeof : Symbol(react.transitional.element)
|
|
336
|
+
* type : (props) => /\* @\_\_PURE\_\_ \*/ jsxDEV(ValidationBase, { ...props, as: "div" }, void 0, false, { fileName: "/home/runner/work/design-system/design-system/packages/components/src/components/ValidationMessage/ValidationMessage.tsx", lineNumber: 10, columnNumber: 1 }, this)
|
|
337
|
+
* key : null
|
|
338
|
+
* props :
|
|
339
|
+
|
|
340
|
+
{...} 1 key
|
|
341
|
+
|
|
342
|
+
* \_owner : null
|
|
343
|
+
* \_store :
|
|
344
|
+
|
|
345
|
+
{...} 0 keys
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
|
357
|
+
| label\* |
|
|
358
|
+
|
|
359
|
+
Text to be displayed in the label.
|
|
360
|
+
|
|
361
|
+
ReactNode
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
| \- |
|
|
366
|
+
|
|
367
|
+
"Custom error"
|
|
368
|
+
|
|
369
|
+
|
|
|
370
|
+
| readOnly |
|
|
371
|
+
|
|
372
|
+
Renders the group in a read-only state (no asterisk symbol).
|
|
373
|
+
|
|
374
|
+
boolean
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
| \- | Set boolean |
|
|
379
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
380
|
+
|
|
381
|
+
### Hidden label
|
|
137
382
|
|
|
138
383
|
There may be certain situations where you might want to (accessibly) hide the field label (in a search field for instance). This can be done by setting the `hiddenLabel` prop.
|
|
139
384
|
|
|
385
|
+
[](./iframe.html?id=components-field--hidden-label)
|
|
386
|
+
|
|
140
387
|
This label is hidden
|
|
141
388
|
|
|
142
389
|
This hint text is hidden
|
|
143
390
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
\[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; }
|
|
391
|
+
```
|
|
147
392
|
|
|
148
393
|
<IressField
|
|
149
394
|
hiddenLabel
|
|
150
395
|
hint\="This hint text is hidden"
|
|
151
396
|
label\="This label is hidden"
|
|
152
397
|
\>
|
|
153
|
-
<
|
|
398
|
+
<ForwardedInput
|
|
154
399
|
id\="name"
|
|
155
400
|
name\="input1"
|
|
156
401
|
required
|
|
@@ -158,7 +403,59 @@ Hide code
|
|
|
158
403
|
/>
|
|
159
404
|
</IressField\>
|
|
160
405
|
|
|
161
|
-
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
#### Props
|
|
409
|
+
|
|
410
|
+
| Name | Description | Default | Control |
|
|
411
|
+
| --- | --- | --- | --- |
|
|
412
|
+
| children |
|
|
413
|
+
The form control this field is related to.
|
|
414
|
+
|
|
415
|
+
ReactReactNode
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
| \- | \- |
|
|
420
|
+
| hiddenLabel |
|
|
421
|
+
|
|
422
|
+
boolean
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
| \- | FalseTrue |
|
|
427
|
+
| hint |
|
|
428
|
+
|
|
429
|
+
string
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
| \- | This hint text is hidden |
|
|
434
|
+
| label\* |
|
|
435
|
+
|
|
436
|
+
Text to be displayed in the label.
|
|
437
|
+
|
|
438
|
+
ReactNode
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
| \- |
|
|
443
|
+
|
|
444
|
+
"This label is hidden"
|
|
445
|
+
|
|
446
|
+
|
|
|
447
|
+
| readOnly |
|
|
448
|
+
|
|
449
|
+
Renders the group in a read-only state (no asterisk symbol).
|
|
450
|
+
|
|
451
|
+
boolean
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
| \- | Set boolean |
|
|
456
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
457
|
+
|
|
458
|
+
[](./iframe.html?id=components-field--hidden-label-with-error)
|
|
162
459
|
|
|
163
460
|
This label is hidden
|
|
164
461
|
|
|
@@ -168,9 +465,7 @@ Error:
|
|
|
168
465
|
|
|
169
466
|
Even fields with hidden labels will show their validation message
|
|
170
467
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
\[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; }
|
|
468
|
+
```
|
|
174
469
|
|
|
175
470
|
<IressField
|
|
176
471
|
error\={<IressValidationMessage\>Even fields with hidden labels will show their validation message</IressValidationMessage\>}
|
|
@@ -178,7 +473,7 @@ Hide code
|
|
|
178
473
|
hint\="This hint text is hidden"
|
|
179
474
|
label\="This label is hidden"
|
|
180
475
|
\>
|
|
181
|
-
<
|
|
476
|
+
<ForwardedInput
|
|
182
477
|
id\="name"
|
|
183
478
|
name\="input1"
|
|
184
479
|
required
|
|
@@ -186,23 +481,109 @@ Hide code
|
|
|
186
481
|
/>
|
|
187
482
|
</IressField\>
|
|
188
483
|
|
|
189
|
-
|
|
484
|
+
```
|
|
485
|
+
|
|
486
|
+
#### Props
|
|
487
|
+
|
|
488
|
+
| Name | Description | Default | Control |
|
|
489
|
+
| --- | --- | --- | --- |
|
|
490
|
+
| children |
|
|
491
|
+
The form control this field is related to.
|
|
492
|
+
|
|
493
|
+
ReactReactNode
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
| \- | \- |
|
|
498
|
+
| error |
|
|
499
|
+
|
|
500
|
+
object
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
| \- |
|
|
505
|
+
|
|
506
|
+
RAW
|
|
507
|
+
|
|
508
|
+
error :
|
|
509
|
+
|
|
510
|
+
{
|
|
511
|
+
|
|
512
|
+
* $$typeof : Symbol(react.transitional.element)
|
|
513
|
+
* type : (props) => /\* @\_\_PURE\_\_ \*/ jsxDEV(ValidationBase, { ...props, as: "div" }, void 0, false, { fileName: "/home/runner/work/design-system/design-system/packages/components/src/components/ValidationMessage/ValidationMessage.tsx", lineNumber: 10, columnNumber: 1 }, this)
|
|
514
|
+
* key : null
|
|
515
|
+
* props :
|
|
516
|
+
|
|
517
|
+
{...} 1 key
|
|
518
|
+
|
|
519
|
+
* \_owner : null
|
|
520
|
+
* \_store :
|
|
521
|
+
|
|
522
|
+
{...} 0 keys
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
}
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
|
534
|
+
| hiddenLabel |
|
|
535
|
+
|
|
536
|
+
boolean
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
| \- | FalseTrue |
|
|
541
|
+
| hint |
|
|
542
|
+
|
|
543
|
+
string
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
| \- | This hint text is hidden |
|
|
548
|
+
| label\* |
|
|
190
549
|
|
|
191
|
-
|
|
550
|
+
Text to be displayed in the label.
|
|
551
|
+
|
|
552
|
+
ReactNode
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
| \- |
|
|
557
|
+
|
|
558
|
+
"This label is hidden"
|
|
559
|
+
|
|
560
|
+
|
|
|
561
|
+
| readOnly |
|
|
562
|
+
|
|
563
|
+
Renders the group in a read-only state (no asterisk symbol).
|
|
564
|
+
|
|
565
|
+
boolean
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
| \- | Set boolean |
|
|
570
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
571
|
+
|
|
572
|
+
### Required
|
|
192
573
|
|
|
193
574
|
Fields marked as `required` will have an asterisk prepended to the label.
|
|
194
575
|
|
|
195
|
-
|
|
576
|
+
[](./iframe.html?id=components-field--required)
|
|
196
577
|
|
|
197
|
-
|
|
578
|
+
\*Required This field is required
|
|
198
579
|
|
|
199
|
-
|
|
580
|
+
```
|
|
200
581
|
|
|
201
582
|
<IressField
|
|
202
583
|
label\="This field is required"
|
|
203
584
|
required
|
|
204
585
|
\>
|
|
205
|
-
<
|
|
586
|
+
<ForwardedInput
|
|
206
587
|
id\="name"
|
|
207
588
|
name\="input1"
|
|
208
589
|
required
|
|
@@ -210,25 +591,68 @@ Hide code
|
|
|
210
591
|
/>
|
|
211
592
|
</IressField\>
|
|
212
593
|
|
|
213
|
-
|
|
594
|
+
```
|
|
595
|
+
|
|
596
|
+
#### Props
|
|
597
|
+
|
|
598
|
+
| Name | Description | Default | Control |
|
|
599
|
+
| --- | --- | --- | --- |
|
|
600
|
+
| children |
|
|
601
|
+
The form control this field is related to.
|
|
602
|
+
|
|
603
|
+
ReactReactNode
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
| \- | \- |
|
|
608
|
+
| label\* |
|
|
609
|
+
|
|
610
|
+
Text to be displayed in the label.
|
|
611
|
+
|
|
612
|
+
ReactNode
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
| \- |
|
|
214
617
|
|
|
215
|
-
|
|
618
|
+
"This field is required"
|
|
619
|
+
|
|
620
|
+
|
|
|
621
|
+
| readOnly |
|
|
622
|
+
|
|
623
|
+
Renders the group in a read-only state (no asterisk symbol).
|
|
624
|
+
|
|
625
|
+
boolean
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
| \- | Set boolean |
|
|
630
|
+
| required |
|
|
631
|
+
|
|
632
|
+
boolean
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
| \- | FalseTrue |
|
|
637
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
638
|
+
|
|
639
|
+
### Optional
|
|
216
640
|
|
|
217
641
|
Fields marked as `optional` will have optional text appended to the label. This is used in cases where the majority of the fields are required, and you only want to highlight the optional fields and not overwhelm the user.
|
|
218
642
|
|
|
219
643
|
You can set `optional` to a string to customise the optional text.
|
|
220
644
|
|
|
221
|
-
|
|
645
|
+
[](./iframe.html?id=components-field--optional)
|
|
222
646
|
|
|
223
|
-
|
|
647
|
+
This field is optional(optional)
|
|
224
648
|
|
|
225
|
-
|
|
649
|
+
```
|
|
226
650
|
|
|
227
651
|
<IressField
|
|
228
652
|
label\="This field is optional"
|
|
229
653
|
optional
|
|
230
654
|
\>
|
|
231
|
-
<
|
|
655
|
+
<ForwardedInput
|
|
232
656
|
id\="name"
|
|
233
657
|
name\="input1"
|
|
234
658
|
required
|
|
@@ -236,23 +660,66 @@ Hide code
|
|
|
236
660
|
/>
|
|
237
661
|
</IressField\>
|
|
238
662
|
|
|
239
|
-
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
#### Props
|
|
666
|
+
|
|
667
|
+
| Name | Description | Default | Control |
|
|
668
|
+
| --- | --- | --- | --- |
|
|
669
|
+
| children |
|
|
670
|
+
The form control this field is related to.
|
|
671
|
+
|
|
672
|
+
ReactReactNode
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
| \- | \- |
|
|
677
|
+
| label\* |
|
|
678
|
+
|
|
679
|
+
Text to be displayed in the label.
|
|
680
|
+
|
|
681
|
+
ReactNode
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
| \- |
|
|
686
|
+
|
|
687
|
+
"This field is optional"
|
|
240
688
|
|
|
241
|
-
|
|
689
|
+
|
|
|
690
|
+
| optional |
|
|
691
|
+
|
|
692
|
+
boolean
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
| \- | FalseTrue |
|
|
697
|
+
| readOnly |
|
|
698
|
+
|
|
699
|
+
Renders the group in a read-only state (no asterisk symbol).
|
|
700
|
+
|
|
701
|
+
boolean
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
| \- | Set boolean |
|
|
706
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
707
|
+
|
|
708
|
+
### Readonly data
|
|
242
709
|
|
|
243
710
|
Fields can be used to display read-only data. This is useful when you want to display data that the user can't change, but you still want to display it in a form-like layout.
|
|
244
711
|
|
|
245
712
|
You can also pass `readOnly` prop to remove the asterisk symbol (\*) even when the field is `required`.
|
|
246
713
|
|
|
714
|
+
[](./iframe.html?id=components-field--readonly-data)
|
|
715
|
+
|
|
247
716
|
First name
|
|
248
717
|
|
|
249
718
|
This field is readonly
|
|
250
719
|
|
|
251
720
|
Luke Skywalker
|
|
252
721
|
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
\[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; }
|
|
722
|
+
```
|
|
256
723
|
|
|
257
724
|
<IressField
|
|
258
725
|
hint\="This field is readonly"
|
|
@@ -269,15 +736,67 @@ Hide code
|
|
|
269
736
|
/>
|
|
270
737
|
</IressField\>
|
|
271
738
|
|
|
272
|
-
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
#### Props
|
|
742
|
+
|
|
743
|
+
| Name | Description | Default | Control |
|
|
744
|
+
| --- | --- | --- | --- |
|
|
745
|
+
| children |
|
|
746
|
+
The form control this field is related to.
|
|
747
|
+
|
|
748
|
+
ReactReactNode
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
| \- | \- |
|
|
753
|
+
| hint |
|
|
754
|
+
|
|
755
|
+
string
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
| \- | This field is readonly |
|
|
760
|
+
| label\* |
|
|
761
|
+
|
|
762
|
+
Text to be displayed in the label.
|
|
763
|
+
|
|
764
|
+
ReactNode
|
|
765
|
+
|
|
273
766
|
|
|
274
|
-
|
|
275
|
-
|
|
767
|
+
|
|
768
|
+
| \- |
|
|
769
|
+
|
|
770
|
+
"First name"
|
|
771
|
+
|
|
772
|
+
|
|
|
773
|
+
| readOnly |
|
|
774
|
+
|
|
775
|
+
Renders the group in a read-only state (no asterisk symbol).
|
|
776
|
+
|
|
777
|
+
boolean
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
| \- | FalseTrue |
|
|
782
|
+
| required |
|
|
783
|
+
|
|
784
|
+
boolean
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
| \- | FalseTrue |
|
|
789
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
790
|
+
|
|
791
|
+
`IressFieldGroup`
|
|
792
|
+
-----------------
|
|
276
793
|
|
|
277
794
|
The `IressFieldGroup` component is used to group multiple `Field` components together. This is useful when you have multiple fields that are related to each other, and you want to display them together.
|
|
278
795
|
|
|
279
796
|
Under the hood it uses a `fieldset` and `legend` element to group the fields together, improving the semantics of your form if you use multiple inputs (eg. in the case of a checkbox group) and making it more accessible.
|
|
280
797
|
|
|
798
|
+
[](./iframe.html?id=components-field-fieldgroup--default)
|
|
799
|
+
|
|
281
800
|
Full name
|
|
282
801
|
|
|
283
802
|
Title
|
|
@@ -286,16 +805,14 @@ Title
|
|
|
286
805
|
|
|
287
806
|
\*Required Last name
|
|
288
807
|
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
\[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; }
|
|
808
|
+
```
|
|
292
809
|
|
|
293
810
|
<IressFieldGroup label\="Full name"\>
|
|
294
811
|
<IressField
|
|
295
812
|
htmlFor\="title"
|
|
296
813
|
label\="Title"
|
|
297
814
|
\>
|
|
298
|
-
<
|
|
815
|
+
<ForwardedInput
|
|
299
816
|
id\="title"
|
|
300
817
|
name\="title"
|
|
301
818
|
type\="text"
|
|
@@ -307,7 +824,7 @@ Hide code
|
|
|
307
824
|
label\="First name"
|
|
308
825
|
required
|
|
309
826
|
\>
|
|
310
|
-
<
|
|
827
|
+
<ForwardedInput
|
|
311
828
|
id\="firstName"
|
|
312
829
|
name\="firstName"
|
|
313
830
|
required
|
|
@@ -319,7 +836,7 @@ Hide code
|
|
|
319
836
|
label\="Last name"
|
|
320
837
|
required
|
|
321
838
|
\>
|
|
322
|
-
<
|
|
839
|
+
<ForwardedInput
|
|
323
840
|
id\="lastName"
|
|
324
841
|
name\="lastName"
|
|
325
842
|
required
|
|
@@ -328,12 +845,53 @@ Hide code
|
|
|
328
845
|
</IressField\>
|
|
329
846
|
</IressFieldGroup\>
|
|
330
847
|
|
|
331
|
-
|
|
848
|
+
```
|
|
849
|
+
|
|
850
|
+
#### Props
|
|
851
|
+
|
|
852
|
+
| Name | Description | Default | Control |
|
|
853
|
+
| --- | --- | --- | --- |
|
|
854
|
+
| children |
|
|
855
|
+
Should contain multiple `IressField`, or other elements supported in field group such as `IressButton`.
|
|
856
|
+
|
|
857
|
+
ReactReactNode
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
| \- | \- |
|
|
862
|
+
| inline |
|
|
863
|
+
|
|
864
|
+
Displays multiple children inline rather than stacked, with a small gap.
|
|
865
|
+
|
|
866
|
+
boolean
|
|
867
|
+
|
|
868
|
+
|
|
332
869
|
|
|
333
|
-
|
|
870
|
+
| \- | Set boolean |
|
|
871
|
+
| join |
|
|
872
|
+
|
|
873
|
+
Displays multiple children inline and removes column gap.
|
|
874
|
+
|
|
875
|
+
boolean
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
| \- | Set boolean |
|
|
880
|
+
| label |
|
|
881
|
+
|
|
882
|
+
string
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
| \- | Full name |
|
|
887
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
888
|
+
|
|
889
|
+
### Inline
|
|
334
890
|
|
|
335
891
|
Multiple fields can be displayed inline using the `inline` prop. On smaller screens, inline elements will wrap on to a new line if there's not enough space for everything on one line.
|
|
336
892
|
|
|
893
|
+
[](./iframe.html?id=components-field-fieldgroup--inline)
|
|
894
|
+
|
|
337
895
|
Full name
|
|
338
896
|
|
|
339
897
|
Title
|
|
@@ -342,9 +900,7 @@ Title
|
|
|
342
900
|
|
|
343
901
|
\*Required Last name
|
|
344
902
|
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
\[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; }
|
|
903
|
+
```
|
|
348
904
|
|
|
349
905
|
<IressFieldGroup
|
|
350
906
|
inline
|
|
@@ -354,7 +910,7 @@ Hide code
|
|
|
354
910
|
htmlFor\="title"
|
|
355
911
|
label\="Title"
|
|
356
912
|
\>
|
|
357
|
-
<
|
|
913
|
+
<ForwardedInput
|
|
358
914
|
id\="title"
|
|
359
915
|
name\="title"
|
|
360
916
|
type\="text"
|
|
@@ -366,7 +922,7 @@ Hide code
|
|
|
366
922
|
label\="First name"
|
|
367
923
|
required
|
|
368
924
|
\>
|
|
369
|
-
<
|
|
925
|
+
<ForwardedInput
|
|
370
926
|
id\="firstName"
|
|
371
927
|
name\="firstName"
|
|
372
928
|
required
|
|
@@ -378,7 +934,7 @@ Hide code
|
|
|
378
934
|
label\="Last name"
|
|
379
935
|
required
|
|
380
936
|
\>
|
|
381
|
-
<
|
|
937
|
+
<ForwardedInput
|
|
382
938
|
id\="lastName"
|
|
383
939
|
name\="lastName"
|
|
384
940
|
required
|
|
@@ -387,7 +943,48 @@ Hide code
|
|
|
387
943
|
</IressField\>
|
|
388
944
|
</IressFieldGroup\>
|
|
389
945
|
|
|
390
|
-
|
|
946
|
+
```
|
|
947
|
+
|
|
948
|
+
#### Props
|
|
949
|
+
|
|
950
|
+
| Name | Description | Default | Control |
|
|
951
|
+
| --- | --- | --- | --- |
|
|
952
|
+
| children |
|
|
953
|
+
Should contain multiple `IressField`, or other elements supported in field group such as `IressButton`.
|
|
954
|
+
|
|
955
|
+
ReactReactNode
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
| \- | \- |
|
|
960
|
+
| inline |
|
|
961
|
+
|
|
962
|
+
Displays multiple children inline rather than stacked, with a small gap.
|
|
963
|
+
|
|
964
|
+
boolean
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
| \- | FalseTrue |
|
|
969
|
+
| join |
|
|
970
|
+
|
|
971
|
+
Displays multiple children inline and removes column gap.
|
|
972
|
+
|
|
973
|
+
boolean
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
| \- | Set boolean |
|
|
978
|
+
| label |
|
|
979
|
+
|
|
980
|
+
string
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
| \- | Full name |
|
|
985
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
986
|
+
|
|
987
|
+
[](./iframe.html?id=components-field-fieldgroup--inline-sink)
|
|
391
988
|
|
|
392
989
|
Full name
|
|
393
990
|
|
|
@@ -405,9 +1002,7 @@ Submit
|
|
|
405
1002
|
|
|
406
1003
|
Settings goes here
|
|
407
1004
|
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
\[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; }
|
|
1005
|
+
```
|
|
411
1006
|
|
|
412
1007
|
<form\>
|
|
413
1008
|
<IressFieldGroup
|
|
@@ -459,7 +1054,7 @@ Hide code
|
|
|
459
1054
|
label\="First name"
|
|
460
1055
|
required
|
|
461
1056
|
\>
|
|
462
|
-
<
|
|
1057
|
+
<ForwardedInput
|
|
463
1058
|
id\="firstName"
|
|
464
1059
|
required
|
|
465
1060
|
/>
|
|
@@ -469,7 +1064,7 @@ Hide code
|
|
|
469
1064
|
label\="Last name"
|
|
470
1065
|
required
|
|
471
1066
|
\>
|
|
472
|
-
<
|
|
1067
|
+
<ForwardedInput
|
|
473
1068
|
id\="lastName"
|
|
474
1069
|
required
|
|
475
1070
|
/>
|
|
@@ -483,14 +1078,55 @@ Hide code
|
|
|
483
1078
|
</IressFieldGroup\>
|
|
484
1079
|
</form\>
|
|
485
1080
|
|
|
486
|
-
|
|
1081
|
+
```
|
|
1082
|
+
|
|
1083
|
+
#### Props
|
|
1084
|
+
|
|
1085
|
+
| Name | Description | Default | Control |
|
|
1086
|
+
| --- | --- | --- | --- |
|
|
1087
|
+
| children |
|
|
1088
|
+
Should contain multiple `IressField`, or other elements supported in field group such as `IressButton`.
|
|
1089
|
+
|
|
1090
|
+
ReactReactNode
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
| \- | \- |
|
|
1095
|
+
| inline |
|
|
1096
|
+
|
|
1097
|
+
Displays multiple children inline rather than stacked, with a small gap.
|
|
1098
|
+
|
|
1099
|
+
boolean
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
| \- | FalseTrue |
|
|
1104
|
+
| join |
|
|
1105
|
+
|
|
1106
|
+
Displays multiple children inline and removes column gap.
|
|
1107
|
+
|
|
1108
|
+
boolean
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
| \- | Set boolean |
|
|
1113
|
+
| label |
|
|
487
1114
|
|
|
488
|
-
|
|
1115
|
+
string
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
| \- | Full name |
|
|
1120
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
1121
|
+
|
|
1122
|
+
### Join
|
|
489
1123
|
|
|
490
1124
|
Elements can also be joined together using the `join` prop. Joined elements won't wrap on to a new line, so make sure you test your designs on small screens; depending on the use case, you may be better off with a standard inline layout (or two separate fields!).
|
|
491
1125
|
|
|
492
1126
|
**Note:** The `join` prop works out of the box with IDS components. To enable your custom components to work with the `join` prop, you need to ensure the direct child of `IressFieldGroup` has the class `GlobalCSSClass.FormElement`. If the direct child is not the element with the border, add the class `GlobalCSSClass.FormElementInner` to the element with the border.
|
|
493
1127
|
|
|
1128
|
+
[](./iframe.html?id=components-field-fieldgroup--join)
|
|
1129
|
+
|
|
494
1130
|
Full name
|
|
495
1131
|
|
|
496
1132
|
Title
|
|
@@ -499,9 +1135,7 @@ Title
|
|
|
499
1135
|
|
|
500
1136
|
\*Required Last name
|
|
501
1137
|
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
\[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; }
|
|
1138
|
+
```
|
|
505
1139
|
|
|
506
1140
|
<IressFieldGroup
|
|
507
1141
|
join
|
|
@@ -511,7 +1145,7 @@ Hide code
|
|
|
511
1145
|
htmlFor\="title"
|
|
512
1146
|
label\="Title"
|
|
513
1147
|
\>
|
|
514
|
-
<
|
|
1148
|
+
<ForwardedInput
|
|
515
1149
|
id\="title"
|
|
516
1150
|
name\="title"
|
|
517
1151
|
type\="text"
|
|
@@ -523,7 +1157,7 @@ Hide code
|
|
|
523
1157
|
label\="First name"
|
|
524
1158
|
required
|
|
525
1159
|
\>
|
|
526
|
-
<
|
|
1160
|
+
<ForwardedInput
|
|
527
1161
|
id\="firstName"
|
|
528
1162
|
name\="firstName"
|
|
529
1163
|
required
|
|
@@ -535,7 +1169,7 @@ Hide code
|
|
|
535
1169
|
label\="Last name"
|
|
536
1170
|
required
|
|
537
1171
|
\>
|
|
538
|
-
<
|
|
1172
|
+
<ForwardedInput
|
|
539
1173
|
id\="lastName"
|
|
540
1174
|
name\="lastName"
|
|
541
1175
|
required
|
|
@@ -544,7 +1178,48 @@ Hide code
|
|
|
544
1178
|
</IressField\>
|
|
545
1179
|
</IressFieldGroup\>
|
|
546
1180
|
|
|
547
|
-
|
|
1181
|
+
```
|
|
1182
|
+
|
|
1183
|
+
#### Props
|
|
1184
|
+
|
|
1185
|
+
| Name | Description | Default | Control |
|
|
1186
|
+
| --- | --- | --- | --- |
|
|
1187
|
+
| children |
|
|
1188
|
+
Should contain multiple `IressField`, or other elements supported in field group such as `IressButton`.
|
|
1189
|
+
|
|
1190
|
+
ReactReactNode
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
| \- | \- |
|
|
1195
|
+
| inline |
|
|
1196
|
+
|
|
1197
|
+
Displays multiple children inline rather than stacked, with a small gap.
|
|
1198
|
+
|
|
1199
|
+
boolean
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
| \- | Set boolean |
|
|
1204
|
+
| join |
|
|
1205
|
+
|
|
1206
|
+
Displays multiple children inline and removes column gap.
|
|
1207
|
+
|
|
1208
|
+
boolean
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
| \- | FalseTrue |
|
|
1213
|
+
| label |
|
|
1214
|
+
|
|
1215
|
+
string
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
| \- | Full name |
|
|
1220
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
1221
|
+
|
|
1222
|
+
[](./iframe.html?id=components-field-fieldgroup--join-sink)
|
|
548
1223
|
|
|
549
1224
|
Full name
|
|
550
1225
|
|
|
@@ -562,9 +1237,7 @@ Submit
|
|
|
562
1237
|
|
|
563
1238
|
Settings goes here
|
|
564
1239
|
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
\[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; }
|
|
1240
|
+
```
|
|
568
1241
|
|
|
569
1242
|
<form\>
|
|
570
1243
|
<IressFieldGroup
|
|
@@ -617,7 +1290,7 @@ Hide code
|
|
|
617
1290
|
label\="First name"
|
|
618
1291
|
required
|
|
619
1292
|
\>
|
|
620
|
-
<
|
|
1293
|
+
<ForwardedInput
|
|
621
1294
|
id\="firstName"
|
|
622
1295
|
required
|
|
623
1296
|
/>
|
|
@@ -627,7 +1300,7 @@ Hide code
|
|
|
627
1300
|
label\="Last name"
|
|
628
1301
|
required
|
|
629
1302
|
\>
|
|
630
|
-
<
|
|
1303
|
+
<ForwardedInput
|
|
631
1304
|
id\="lastName"
|
|
632
1305
|
required
|
|
633
1306
|
/>
|
|
@@ -641,10 +1314,49 @@ Hide code
|
|
|
641
1314
|
</IressFieldGroup\>
|
|
642
1315
|
</form\>
|
|
643
1316
|
|
|
644
|
-
|
|
1317
|
+
```
|
|
1318
|
+
|
|
1319
|
+
#### Props
|
|
1320
|
+
|
|
1321
|
+
| Name | Description | Default | Control |
|
|
1322
|
+
| --- | --- | --- | --- |
|
|
1323
|
+
| children |
|
|
1324
|
+
Should contain multiple `IressField`, or other elements supported in field group such as `IressButton`.
|
|
1325
|
+
|
|
1326
|
+
ReactReactNode
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
| \- | \- |
|
|
1331
|
+
| inline |
|
|
1332
|
+
|
|
1333
|
+
Displays multiple children inline rather than stacked, with a small gap.
|
|
1334
|
+
|
|
1335
|
+
boolean
|
|
1336
|
+
|
|
645
1337
|
|
|
646
|
-
|
|
647
|
-
|
|
1338
|
+
|
|
1339
|
+
| \- | FalseTrue |
|
|
1340
|
+
| join |
|
|
1341
|
+
|
|
1342
|
+
Displays multiple children inline and removes column gap.
|
|
1343
|
+
|
|
1344
|
+
boolean
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
| \- | FalseTrue |
|
|
1349
|
+
| label |
|
|
1350
|
+
|
|
1351
|
+
string
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
| \- | Full name |
|
|
1356
|
+
| Show Storybook only itemsStorybook only | Show Storybook only items |
|
|
1357
|
+
|
|
1358
|
+
`IressForm` integration
|
|
1359
|
+
-----------------------
|
|
648
1360
|
|
|
649
1361
|
As of version 5, `IressField` is a standalone component and does not handle validation.
|
|
650
1362
|
|
|
@@ -655,21 +1367,3 @@ If you want out-of-the-box validation, use the `IressFormField` inside an `Iress
|
|
|
655
1367
|
View forms documentation for fields
|
|
656
1368
|
|
|
657
1369
|
](/?path=/docs/components-form--docs#fields)
|
|
658
|
-
|
|
659
|
-
On this page
|
|
660
|
-
|
|
661
|
-
* [Overview](#overview)
|
|
662
|
-
* [Props](#props)
|
|
663
|
-
* [Examples](#examples)
|
|
664
|
-
* [Label](#label)
|
|
665
|
-
* [Hint](#hint)
|
|
666
|
-
* [Error message](#error-message)
|
|
667
|
-
* [Custom error](#custom-error)
|
|
668
|
-
* [Hidden label](#hidden-label)
|
|
669
|
-
* [Required](#required)
|
|
670
|
-
* [Optional](#optional)
|
|
671
|
-
* [Readonly data](#readonly-data)
|
|
672
|
-
* [IressFieldGroup](#iressfieldgroup)
|
|
673
|
-
* [Inline](#inline)
|
|
674
|
-
* [Join](#join)
|
|
675
|
-
* [IressForm integration](#iressform-integration)
|