-
Notifications
You must be signed in to change notification settings - Fork 332
/
date-input.yaml
408 lines (406 loc) · 9.54 KB
/
date-input.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
params:
- name: id
type: string
required: true
description: This is used for the main component and to compose the ID attribute for each item.
- name: namePrefix
type: string
required: false
description: Optional prefix. This is used to prefix each `item.name` using `-`.
- name: items
type: array
required: false
description: An array of input objects with name, value and classes.
params:
- name: id
type: string
required: false
description: Item-specific ID. If provided, it will be used instead of the generated ID.
- name: name
type: string
required: true
description: Item-specific name attribute.
- name: label
type: string
required: false
description: Item-specific label text. If provided, this will be used instead of `name` for item label text.
- name: value
type: string
required: false
description: If provided, it will be used as the initial value of the input.
- name: autocomplete
type: string
required: false
description: Attribute to [identify input purpose](https://www.w3.org/WAI/WCAG21/Understanding/identify-input-purpose.html), for instance `bday-day`. See [autofill](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill) for full list of attributes that can be used.
- name: pattern
type: string
required: false
description: Attribute to [provide a regular expression pattern](https://www.w3.org/TR/html51/sec-forms.html#the-pattern-attribute), used to match allowed character combinations for the input value.
- name: classes
type: string
required: false
description: Classes to add to date input item.
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the date input tag.
- name: hint
type: object
required: false
description: Options for the hint component.
isComponent: true
- name: errorMessage
type: object
required: false
description: Options for the error message component. The error message component will not display if you use a falsy value for `errorMessage`, for example `false` or `null`.
isComponent: true
- name: formGroup
type: object
required: false
description: Options for the form-group wrapper.
params:
- name: classes
type: string
required: false
description: Classes to add to the form group (for example to show error state for the whole group).
- name: fieldset
type: object
required: false
description: Options for the fieldset component (for example legend).
isComponent: true
- name: classes
type: string
required: false
description: Classes to add to the date-input container.
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the date-input container.
examples:
- name: default
data:
id: dob
- name: complete question
data:
id: dob
namePrefix: dob
fieldset:
legend:
text: What is your date of birth?
hint:
text: For example, 31 3 1980
items:
-
name: day
classes: govuk-input--width-2
-
name: month
classes: govuk-input--width-2
-
name: year
classes: govuk-input--width-4
- name: with errors only
data:
id: dob-errors
fieldset:
legend:
text: What is your date of birth?
errorMessage:
text: Error message goes here
items:
-
name: day
classes: govuk-input--width-2 govuk-input--error
-
name: month
classes: govuk-input--width-2 govuk-input--error
-
name: year
classes: govuk-input--width-4 govuk-input--error
- name: with errors and hint
data:
id: dob-errors
fieldset:
legend:
text: What is your date of birth?
hint:
text: For example, 31 3 1980
errorMessage:
text: Error message goes here
items:
-
name: day
classes: govuk-input--width-2 govuk-input--error
-
name: month
classes: govuk-input--width-2 govuk-input--error
-
name: year
classes: govuk-input--width-4 govuk-input--error
- name: with error on day input
data:
id: dob-day-error
namePrefix: dob-day-error
fieldset:
legend:
text: What is your date of birth?
hint:
text: For example, 31 3 1980
errorMessage:
text: Error message goes here
items:
-
name: day
classes: govuk-input--width-2 govuk-input--error
-
name: month
classes: govuk-input--width-2
-
name: year
classes: govuk-input--width-4
- name: with error on month input
data:
id: dob-month-error
namePrefix: dob-month-error
fieldset:
legend:
text: What is your date of birth?
hint:
text: For example, 31 3 1980
errorMessage:
text: Error message goes here
items:
-
name: day
classes: govuk-input--width-2
-
name: month
classes: govuk-input--width-2 govuk-input--error
-
name: year
classes: govuk-input--width-4
- name: with error on year input
data:
id: dob-year-error
namePrefix: dob-year-error
fieldset:
legend:
text: What is your date of birth?
hint:
text: For example, 31 3 1980
errorMessage:
text: Error message goes here
items:
-
name: day
classes: govuk-input--width-2
-
name: month
classes: govuk-input--width-2
-
name: year
classes: govuk-input--width-4 govuk-input--error
- name: with default items
data:
id: dob
namePrefix: dob
fieldset:
legend:
text: What is your date of birth?
hint:
text: For example, 31 3 1980
- name: with optional form-group classes
data:
id: dob
namePrefix: dob
fieldset:
legend:
text: What is your date of birth?
hint:
text: For example, 31 3 1980
formGroup:
classes: extra-class
- name: with autocomplete values
data:
id: dob-with-autocomplete-attribute
namePrefix: dob-with-autocomplete
fieldset:
legend:
text: What is your date of birth?
hint:
text: For example, 31 3 1980
items:
-
name: day
classes: govuk-input--width-2
autocomplete: bday-day
-
name: month
classes: govuk-input--width-2
autocomplete: bday-month
-
name: year
classes: govuk-input--width-4
autocomplete: bday-year
- name: with input attributes
data:
id: dob-with-input-attributes
namePrefix: dob-with-input-attributes
fieldset:
legend:
text: What is your date of birth?
hint:
text: For example, 31 3 1980
items:
-
name: day
classes: govuk-input--width-2
attributes:
data-example-day: day
-
name: month
classes: govuk-input--width-2
attributes:
data-example-month: month
-
name: year
classes: govuk-input--width-4
attributes:
data-example-year: year
# Hidden examples are not shown in the review app, but are used for tests and HTML fixtures
- name: classes
hidden: true
data:
id: with-classes
classes: app-date-input--custom-modifier
- name: attributes
hidden: true
data:
id: with-attributes
attributes:
data-attribute: my data value
- name: with empty items
hidden: true
data:
id: with-empty-items
items: []
- name: custom pattern
hidden: true
data:
id: with-custom-pattern
items:
-
name: day
pattern: '[0-8]*'
- name: custom inputmode
hidden: true
data:
id: with-custom-inputmode
items:
-
name: day
pattern: '[0-9X]*'
inputmode: 'text'
- name: with nested name
hidden: true
data:
id: with-nested-name
items:
-
name: day[dd]
-
name: month[mm]
-
name: year[yyyy]
- name: with id on items
hidden: true
data:
id: with-item-id
items:
-
id: day
name: day
-
id: month
name: month
-
id: year
name: year
- name: suffixed id
hidden: true
data:
id: my-date-input
items:
-
name: day
-
name: month
-
name: year
- name: with values
hidden: true
data:
id: with-values
items:
-
id: day
name: day
-
id: month
name: month
-
id: year
name: year
value: 2018
- name: with hint and describedBy
hidden: true
data:
id: dob-errors
fieldset:
describedBy: some-id
legend:
text: What is your date of birth?
hint:
text: For example, 31 3 1980
- name: with error and describedBy
hidden: true
data:
id: dob-errors
fieldset:
describedBy: some-id
legend:
text: What is your date of birth?
errorMessage:
text: Error message goes here
- name: fieldset html
hidden: true
data:
id: with-fieldset-html
fieldset:
legend:
html: What is your <b>date of birth</b>?
- name: items with classes
hidden: true
data:
id: with-item-classes
items:
-
name: day
classes: app-date-input__day
-
name: month
classes: app-date-input__month
-
name: year
classes: app-date-input__year
- name: items without classes
hidden: true
data:
id: without-item-classes
items:
-
name: day
-
name: month
-
name: year