@openremote/or-vaadin-components 1.18.0 → 1.19.0-snapshot.20260224160549
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/custom-elements-jsx.d.ts +3077 -17
- package/custom-elements-manifest.config.mjs +116 -0
- package/custom-elements.json +108564 -826
- package/lib/or-vaadin-button.d.ts +4 -1
- package/lib/or-vaadin-button.d.ts.map +1 -1
- package/lib/or-vaadin-button.js.map +1 -1
- package/lib/or-vaadin-checkbox.d.ts +4 -1
- package/lib/or-vaadin-checkbox.d.ts.map +1 -1
- package/lib/or-vaadin-checkbox.js.map +1 -1
- package/lib/or-vaadin-dialog.d.ts +3 -1
- package/lib/or-vaadin-dialog.d.ts.map +1 -1
- package/lib/or-vaadin-dialog.js.map +1 -1
- package/lib/or-vaadin-number-field.d.ts +1 -1
- package/lib/or-vaadin-number-field.d.ts.map +1 -1
- package/lib/or-vaadin-password-field.d.ts +1 -1
- package/lib/or-vaadin-password-field.d.ts.map +1 -1
- package/lib/or-vaadin-select.d.ts +4 -1
- package/lib/or-vaadin-select.d.ts.map +1 -1
- package/lib/or-vaadin-select.js.map +1 -1
- package/lib/or-vaadin-text-area.d.ts +1 -1
- package/lib/or-vaadin-text-area.d.ts.map +1 -1
- package/lib/or-vaadin-text-field.d.ts +1 -1
- package/lib/or-vaadin-text-field.d.ts.map +1 -1
- package/package.json +4 -4
- package/stories/or-vaadin-button.stories.ts +79 -0
- package/stories/or-vaadin-checkbox.stories.ts +59 -0
- package/stories/or-vaadin-dialog.stories.ts +3 -3
- package/stories/or-vaadin-number-field.stories.ts +60 -0
- package/stories/or-vaadin-text-field.stories.ts +3 -3
package/custom-elements-jsx.d.ts
CHANGED
|
@@ -15,6 +15,43 @@ import type { OrVaadinSelect } from "./lib/or-vaadin-select.d.ts";
|
|
|
15
15
|
import type { OrVaadinTextArea } from "./lib/or-vaadin-text-area.d.ts";
|
|
16
16
|
import type { OrVaadinTextField } from "./lib/or-vaadin-text-field.d.ts";
|
|
17
17
|
import type { OrVaadinTimePicker } from "./lib/or-vaadin-time-picker.d.ts";
|
|
18
|
+
import type { Checkbox } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/checkbox/./lib/vaadin-checkbox.js";
|
|
19
|
+
import type { Button } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/button/./lib/vaadin-button.js";
|
|
20
|
+
import type { CheckboxGroup } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/checkbox-group/./lib/vaadin-checkbox-group.js";
|
|
21
|
+
import type { ComboBoxItem } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/combo-box/./lib/vaadin-combo-box-item.js";
|
|
22
|
+
import type { ComboBoxOverlay } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/combo-box/./lib/vaadin-combo-box-overlay.js";
|
|
23
|
+
import type { ComboBoxScroller } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/combo-box/./lib/vaadin-combo-box-scroller.js";
|
|
24
|
+
import type { ComboBox } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/combo-box/./lib/vaadin-combo-box.js";
|
|
25
|
+
import type { CustomField } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/custom-field/./lib/vaadin-custom-field.js";
|
|
26
|
+
import type { DatePickerYear } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/date-picker/./lib/vaadin-date-picker-year.js";
|
|
27
|
+
import type { DatePicker } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/date-picker/./lib/vaadin-date-picker.js";
|
|
28
|
+
import type { InfiniteScroller } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/date-picker/./lib/vaadin-infinite-scroller.js";
|
|
29
|
+
import type { DateTimePicker } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/date-time-picker/./lib/vaadin-date-time-picker.js";
|
|
30
|
+
import type { DialogOverlay } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/dialog/./lib/vaadin-dialog-overlay.js";
|
|
31
|
+
import type { Dialog } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/dialog/./lib/vaadin-dialog.js";
|
|
32
|
+
import type { Icon } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/icon/./lib/vaadin-icon.js";
|
|
33
|
+
import type { Iconset } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/icon/./lib/vaadin-iconset.js";
|
|
34
|
+
import type { InputContainer } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/input-container/./lib/vaadin-input-container.js";
|
|
35
|
+
import type { MultiSelectComboBoxItem } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/multi-select-combo-box/./lib/vaadin-multi-select-combo-box-item.js";
|
|
36
|
+
import type { MultiSelectComboBoxScroller } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/multi-select-combo-box/./lib/vaadin-multi-select-combo-box-scroller.js";
|
|
37
|
+
import type { MultiSelectComboBox } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/multi-select-combo-box/./lib/vaadin-multi-select-combo-box.js";
|
|
38
|
+
import type { Item } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/item/./lib/vaadin-item.js";
|
|
39
|
+
import type { NumberField } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/number-field/./lib/vaadin-number-field.js";
|
|
40
|
+
import type { ListBox } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/list-box/./lib/vaadin-list-box.js";
|
|
41
|
+
import type { PasswordField } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/password-field/./lib/vaadin-password-field.js";
|
|
42
|
+
import type { RadioButton } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/radio-group/./lib/vaadin-radio-button.js";
|
|
43
|
+
import type { RadioGroup } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/radio-group/./lib/vaadin-radio-group.js";
|
|
44
|
+
import type { SelectItem } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/select/./lib/vaadin-select-item.js";
|
|
45
|
+
import type { SelectListBox } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/select/./lib/vaadin-select-list-box.js";
|
|
46
|
+
import type { SelectOverlay } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/select/./lib/vaadin-select-overlay.js";
|
|
47
|
+
import type { Select } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/select/./lib/vaadin-select.js";
|
|
48
|
+
import type { TextArea } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/text-area/./lib/vaadin-text-area.js";
|
|
49
|
+
import type { Overlay } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/overlay/./lib/vaadin-overlay.js";
|
|
50
|
+
import type { TextField } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/text-field/./lib/vaadin-text-field.js";
|
|
51
|
+
import type { TimePickerItem } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/time-picker/./lib/vaadin-time-picker-item.js";
|
|
52
|
+
import type { TimePickerOverlay } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/time-picker/./lib/vaadin-time-picker-overlay.js";
|
|
53
|
+
import type { TimePickerScroller } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/time-picker/./lib/vaadin-time-picker-scroller.js";
|
|
54
|
+
import type { TimePicker } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/time-picker/./lib/vaadin-time-picker.js";
|
|
18
55
|
|
|
19
56
|
/**
|
|
20
57
|
* This type can be used to create scoped tags for your components.
|
|
@@ -96,44 +133,648 @@ type BaseEvents = {
|
|
|
96
133
|
|
|
97
134
|
|
|
98
135
|
export type OrVaadinButtonProps = {
|
|
136
|
+
/** Indicates whether the element can be focused and where it participates in sequential keyboard navigation. */
|
|
137
|
+
"tabindex"?: OrVaadinButton['tabindex'];
|
|
138
|
+
/** Stores the last known tabindex since the element has been disabled. */
|
|
139
|
+
"_lastTabIndex"?: OrVaadinButton['_lastTabIndex'];
|
|
140
|
+
/** */
|
|
141
|
+
"dir"?: OrVaadinButton['dir'];
|
|
142
|
+
/** When disabled, the button is rendered as "dimmed" and prevents all
|
|
143
|
+
user interactions (mouse and keyboard).
|
|
144
|
+
|
|
145
|
+
Since disabled buttons are not focusable and cannot react to hover
|
|
146
|
+
events by default, it can cause accessibility issues by making them
|
|
147
|
+
entirely invisible to assistive technologies, and prevents the use
|
|
148
|
+
of Tooltips to explain why the action is not available. This can be
|
|
149
|
+
addressed by enabling the feature flag `accessibleDisabledButtons`,
|
|
150
|
+
which makes disabled buttons focusable and hoverable, while still
|
|
151
|
+
preventing them from being triggered:
|
|
152
|
+
|
|
153
|
+
```js
|
|
154
|
+
// Set before any button is attached to the DOM.
|
|
155
|
+
window.Vaadin.featureFlags.accessibleDisabledButtons = true
|
|
156
|
+
``` */
|
|
157
|
+
"disabled"?: OrVaadinButton['disabled'];
|
|
158
|
+
/** Set when the button is pressed down, either with mouse, touch or the keyboard */
|
|
159
|
+
"active"?: unknown;
|
|
160
|
+
/** Set when the button is pressed down, either with mouse, touch or the keyboard */
|
|
161
|
+
"undefined"?: unknown;
|
|
162
|
+
/** Set when the button is focused using the keyboard */
|
|
163
|
+
"focus-ring"?: unknown;
|
|
164
|
+
/** Set when the button is focused */
|
|
165
|
+
"focused"?: unknown;
|
|
166
|
+
/** Set when the button has a slotted tooltip */
|
|
167
|
+
"has-tooltip"?: unknown;
|
|
99
168
|
|
|
100
|
-
|
|
169
|
+
/** */
|
|
170
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
101
171
|
}
|
|
102
172
|
|
|
103
173
|
|
|
104
174
|
export type OrVaadinCheckboxGroupProps = {
|
|
175
|
+
/** An array containing values of the currently checked checkboxes.
|
|
176
|
+
|
|
177
|
+
The array is immutable so toggling checkboxes always results in
|
|
178
|
+
creating a new array. */
|
|
179
|
+
"value"?: OrVaadinCheckboxGroup['value'];
|
|
180
|
+
/** When true, the user cannot modify the value of the checkbox group.
|
|
181
|
+
The difference between `disabled` and `readonly` is that in the
|
|
182
|
+
read-only checkbox group, all the checkboxes are also read-only,
|
|
183
|
+
and therefore remain focusable and announced by screen readers. */
|
|
184
|
+
"readonly"?: OrVaadinCheckboxGroup['readonly'];
|
|
185
|
+
/** A target element to which ARIA attributes are set. */
|
|
186
|
+
"ariaTarget"?: OrVaadinCheckboxGroup['ariaTarget'];
|
|
187
|
+
/** Error to show when the field is invalid. */
|
|
188
|
+
"errorMessage"?: OrVaadinCheckboxGroup['errorMessage'];
|
|
189
|
+
/** String used for the helper text. */
|
|
190
|
+
"helperText"?: OrVaadinCheckboxGroup['helperText'];
|
|
191
|
+
/** String used to label the component to screen reader users. */
|
|
192
|
+
"accessibleName"?: OrVaadinCheckboxGroup['accessibleName'];
|
|
193
|
+
/** Id of the element used as label of the component to screen reader users. */
|
|
194
|
+
"accessibleNameRef"?: OrVaadinCheckboxGroup['accessibleNameRef'];
|
|
195
|
+
/** */
|
|
196
|
+
"dir"?: OrVaadinCheckboxGroup['dir'];
|
|
197
|
+
/** Set when the element is disabled */
|
|
198
|
+
"disabled"?: unknown;
|
|
199
|
+
/** Set when the element is disabled */
|
|
200
|
+
"undefined"?: unknown;
|
|
201
|
+
/** Set when the element is invalid */
|
|
202
|
+
"invalid"?: unknown;
|
|
203
|
+
/** Set when the element is focused */
|
|
204
|
+
"focused"?: unknown;
|
|
205
|
+
/** Set when the element has a label */
|
|
206
|
+
"has-label"?: unknown;
|
|
207
|
+
/** Set when the element has a value */
|
|
208
|
+
"has-value"?: unknown;
|
|
209
|
+
/** Set when the element has helper text */
|
|
210
|
+
"has-helper"?: unknown;
|
|
211
|
+
/** Set when the element has an error message */
|
|
212
|
+
"has-error-message"?: unknown;
|
|
213
|
+
/** Set when the element has a slotted tooltip */
|
|
214
|
+
"has-tooltip"?: unknown;
|
|
215
|
+
/** */
|
|
216
|
+
"_tooltipController"?: OrVaadinCheckboxGroup['_tooltipController'];
|
|
217
|
+
/** */
|
|
218
|
+
"_fieldAriaController"?: OrVaadinCheckboxGroup['_fieldAriaController'];
|
|
219
|
+
/** */
|
|
220
|
+
"_helperController"?: OrVaadinCheckboxGroup['_helperController'];
|
|
221
|
+
/** */
|
|
222
|
+
"_errorController"?: OrVaadinCheckboxGroup['_errorController'];
|
|
105
223
|
|
|
106
|
-
|
|
224
|
+
/** */
|
|
225
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
226
|
+
/** Fired when the `invalid` property changes. */
|
|
227
|
+
"oninvalid-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
228
|
+
/** Fired when the `value` property changes. */
|
|
229
|
+
"onvalue-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
230
|
+
/** Fired whenever the field is validated. */
|
|
231
|
+
"onvalidated"?: (e: CustomEvent<CustomEvent>) => void;
|
|
107
232
|
}
|
|
108
233
|
|
|
109
234
|
|
|
110
235
|
export type OrVaadinCheckboxProps = {
|
|
236
|
+
/** True if the checkbox is in the indeterminate state which means
|
|
237
|
+
it is not possible to say whether it is checked or unchecked.
|
|
238
|
+
The state is reset once the user switches the checkbox by hand.
|
|
239
|
+
|
|
240
|
+
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#Indeterminate_state_checkboxes */
|
|
241
|
+
"indeterminate"?: OrVaadinCheckbox['indeterminate'];
|
|
242
|
+
/** The name of the checkbox. */
|
|
243
|
+
"name"?: OrVaadinCheckbox['name'];
|
|
244
|
+
/** When true, the user cannot modify the value of the checkbox.
|
|
245
|
+
The difference between `disabled` and `readonly` is that the
|
|
246
|
+
read-only checkbox remains focusable, is announced by screen
|
|
247
|
+
readers and its value can be submitted as part of the form. */
|
|
248
|
+
"readonly"?: OrVaadinCheckbox['readonly'];
|
|
249
|
+
/** A target element to which ARIA attributes are set. */
|
|
250
|
+
"ariaTarget"?: OrVaadinCheckbox['ariaTarget'];
|
|
251
|
+
/** Error to show when the field is invalid. */
|
|
252
|
+
"errorMessage"?: OrVaadinCheckbox['errorMessage'];
|
|
253
|
+
/** String used for the helper text. */
|
|
254
|
+
"helperText"?: OrVaadinCheckbox['helperText'];
|
|
255
|
+
/** String used to label the component to screen reader users. */
|
|
256
|
+
"accessibleName"?: OrVaadinCheckbox['accessibleName'];
|
|
257
|
+
/** Id of the element used as label of the component to screen reader users. */
|
|
258
|
+
"accessibleNameRef"?: OrVaadinCheckbox['accessibleNameRef'];
|
|
259
|
+
/** */
|
|
260
|
+
"dir"?: OrVaadinCheckbox['dir'];
|
|
261
|
+
/** Set when the checkbox is activated with mouse, touch or the keyboard. */
|
|
262
|
+
"active"?: unknown;
|
|
263
|
+
/** Set when the checkbox is activated with mouse, touch or the keyboard. */
|
|
264
|
+
"undefined"?: unknown;
|
|
265
|
+
/** Set when the checkbox is checked. */
|
|
266
|
+
"checked"?: unknown;
|
|
267
|
+
/** Set when the checkbox is disabled. */
|
|
268
|
+
"disabled"?: unknown;
|
|
269
|
+
/** Set when the checkbox is focused using the keyboard. */
|
|
270
|
+
"focus-ring"?: unknown;
|
|
271
|
+
/** Set when the checkbox is focused. */
|
|
272
|
+
"focused"?: unknown;
|
|
273
|
+
/** Set when the checkbox is invalid. */
|
|
274
|
+
"invalid"?: unknown;
|
|
275
|
+
/** Set when the checkbox has a label. */
|
|
276
|
+
"has-label"?: unknown;
|
|
277
|
+
/** Set when the checkbox has helper text. */
|
|
278
|
+
"has-helper"?: unknown;
|
|
279
|
+
/** Set when the checkbox has an error message. */
|
|
280
|
+
"has-error-message"?: unknown;
|
|
281
|
+
/** Set when the checkbox has a slotted tooltip. */
|
|
282
|
+
"has-tooltip"?: unknown;
|
|
283
|
+
/** */
|
|
284
|
+
"_boundOnInputClick"?: OrVaadinCheckbox['_boundOnInputClick'];
|
|
285
|
+
/** */
|
|
286
|
+
"value"?: OrVaadinCheckbox['value'];
|
|
287
|
+
/** */
|
|
288
|
+
"tabindex"?: OrVaadinCheckbox['tabindex'];
|
|
289
|
+
/** */
|
|
290
|
+
"_fieldAriaController"?: OrVaadinCheckbox['_fieldAriaController'];
|
|
291
|
+
/** */
|
|
292
|
+
"_helperController"?: OrVaadinCheckbox['_helperController'];
|
|
293
|
+
/** */
|
|
294
|
+
"_errorController"?: OrVaadinCheckbox['_errorController'];
|
|
111
295
|
|
|
112
|
-
|
|
296
|
+
/** */
|
|
297
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
298
|
+
/** Fired when the checkbox is checked or unchecked by the user. */
|
|
299
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
|
300
|
+
/** Fired when the `checked` property changes. */
|
|
301
|
+
"onchecked-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
302
|
+
/** Fired when the `indeterminate` property changes. */
|
|
303
|
+
"onindeterminate-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
113
304
|
}
|
|
114
305
|
|
|
115
306
|
|
|
116
307
|
export type OrVaadinDatePickerProps = {
|
|
308
|
+
/** The current selected date. */
|
|
309
|
+
"_selectedDate"?: OrVaadinDatePicker['_selectedDate'];
|
|
310
|
+
/** */
|
|
311
|
+
"_focusedDate"?: OrVaadinDatePicker['_focusedDate'];
|
|
312
|
+
/** Selected date.
|
|
313
|
+
|
|
314
|
+
Supported date formats:
|
|
315
|
+
- ISO 8601 `"YYYY-MM-DD"` (default)
|
|
316
|
+
- 6-digit extended ISO 8601 `"+YYYYYY-MM-DD"`, `"-YYYYYY-MM-DD"` */
|
|
317
|
+
"value"?: OrVaadinDatePicker['value'];
|
|
318
|
+
/** Date which should be visible when there is no value selected.
|
|
319
|
+
|
|
320
|
+
The same date formats as for the `value` property are supported. */
|
|
321
|
+
"initialPosition"?: OrVaadinDatePicker['initialPosition'];
|
|
322
|
+
/** Set true to open the date selector overlay. */
|
|
323
|
+
"opened"?: OrVaadinDatePicker['opened'];
|
|
324
|
+
/** Set true to prevent the overlay from opening automatically. */
|
|
325
|
+
"autoOpenDisabled"?: OrVaadinDatePicker['autoOpenDisabled'];
|
|
326
|
+
/** Set true to display ISO-8601 week numbers in the calendar. Notice that
|
|
327
|
+
displaying week numbers is only supported when `i18n.firstDayOfWeek`
|
|
328
|
+
is 1 (Monday). */
|
|
329
|
+
"showWeekNumbers"?: OrVaadinDatePicker['showWeekNumbers'];
|
|
330
|
+
/** */
|
|
331
|
+
"_fullscreen"?: OrVaadinDatePicker['_fullscreen'];
|
|
332
|
+
/** */
|
|
333
|
+
"_fullscreenMediaQuery"?: OrVaadinDatePicker['_fullscreenMediaQuery'];
|
|
334
|
+
/** The earliest date that can be selected. All earlier dates will be disabled.
|
|
335
|
+
|
|
336
|
+
Supported date formats:
|
|
337
|
+
- ISO 8601 `"YYYY-MM-DD"` (default)
|
|
338
|
+
- 6-digit extended ISO 8601 `"+YYYYYY-MM-DD"`, `"-YYYYYY-MM-DD"` */
|
|
339
|
+
"min"?: OrVaadinDatePicker['min'];
|
|
340
|
+
/** The latest date that can be selected. All later dates will be disabled.
|
|
341
|
+
|
|
342
|
+
Supported date formats:
|
|
343
|
+
- ISO 8601 `"YYYY-MM-DD"` (default)
|
|
344
|
+
- 6-digit extended ISO 8601 `"+YYYYYY-MM-DD"`, `"-YYYYYY-MM-DD"` */
|
|
345
|
+
"max"?: OrVaadinDatePicker['max'];
|
|
346
|
+
/** A function to be used to determine whether the user can select a given date.
|
|
347
|
+
Receives a `DatePickerDate` object of the date to be selected and should return a
|
|
348
|
+
boolean. */
|
|
349
|
+
"isDateDisabled"?: OrVaadinDatePicker['isDateDisabled'];
|
|
350
|
+
/** The earliest date that can be selected. All earlier dates will be disabled. */
|
|
351
|
+
"_minDate"?: OrVaadinDatePicker['_minDate'];
|
|
352
|
+
/** The latest date that can be selected. All later dates will be disabled. */
|
|
353
|
+
"_maxDate"?: OrVaadinDatePicker['_maxDate'];
|
|
354
|
+
/** */
|
|
355
|
+
"_noInput"?: OrVaadinDatePicker['_noInput'];
|
|
356
|
+
/** */
|
|
357
|
+
"_ios"?: OrVaadinDatePicker['_ios'];
|
|
358
|
+
/** */
|
|
359
|
+
"_focusOverlayOnOpen"?: OrVaadinDatePicker['_focusOverlayOnOpen'];
|
|
360
|
+
/** */
|
|
361
|
+
"_overlayContent"?: OrVaadinDatePicker['_overlayContent'];
|
|
362
|
+
/** */
|
|
363
|
+
"__enteredDate"?: OrVaadinDatePicker['__enteredDate'];
|
|
364
|
+
/** The object used to localize this component. To change the default
|
|
365
|
+
localization, replace this with an object that provides all properties, or
|
|
366
|
+
just the individual properties you want to change.
|
|
367
|
+
|
|
368
|
+
Should be overridden by subclasses to provide a custom JSDoc with the
|
|
369
|
+
default I18N properties. */
|
|
370
|
+
"i18n"?: OrVaadinDatePicker['i18n'];
|
|
371
|
+
/** */
|
|
372
|
+
"__effectiveI18n"?: OrVaadinDatePicker['__effectiveI18n'];
|
|
373
|
+
/** A pattern matched against individual characters the user inputs.
|
|
374
|
+
|
|
375
|
+
When set, the field will prevent:
|
|
376
|
+
- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`
|
|
377
|
+
- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`
|
|
378
|
+
- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`
|
|
379
|
+
|
|
380
|
+
For example, to allow entering only numbers and minus signs, use:
|
|
381
|
+
`allowedCharPattern = "[\\d-]"` */
|
|
382
|
+
"allowedCharPattern"?: OrVaadinDatePicker['allowedCharPattern'];
|
|
383
|
+
/** If true, the input text gets fully selected when the field is focused using click or touch / tap. */
|
|
384
|
+
"autoselect"?: OrVaadinDatePicker['autoselect'];
|
|
385
|
+
/** The name of this field. */
|
|
386
|
+
"name"?: OrVaadinDatePicker['name'];
|
|
387
|
+
/** A hint to the user of what can be entered in the field. */
|
|
388
|
+
"placeholder"?: OrVaadinDatePicker['placeholder'];
|
|
389
|
+
/** When present, it specifies that the field is read-only. */
|
|
390
|
+
"readonly"?: OrVaadinDatePicker['readonly'];
|
|
391
|
+
/** The text usually displayed in a tooltip popup when the mouse is over the field. */
|
|
392
|
+
"title"?: OrVaadinDatePicker['title'];
|
|
393
|
+
/** A target element to which ARIA attributes are set. */
|
|
394
|
+
"ariaTarget"?: OrVaadinDatePicker['ariaTarget'];
|
|
395
|
+
/** Error to show when the field is invalid. */
|
|
396
|
+
"errorMessage"?: OrVaadinDatePicker['errorMessage'];
|
|
397
|
+
/** String used for the helper text. */
|
|
398
|
+
"helperText"?: OrVaadinDatePicker['helperText'];
|
|
399
|
+
/** String used to label the component to screen reader users. */
|
|
400
|
+
"accessibleName"?: OrVaadinDatePicker['accessibleName'];
|
|
401
|
+
/** Id of the element used as label of the component to screen reader users. */
|
|
402
|
+
"accessibleNameRef"?: OrVaadinDatePicker['accessibleNameRef'];
|
|
403
|
+
/** Set to true to display the clear icon which clears the input.
|
|
404
|
+
|
|
405
|
+
It is up to the component to choose where to place the clear icon:
|
|
406
|
+
in the Shadow DOM or in the light DOM. In any way, a reference to
|
|
407
|
+
the clear icon element should be provided via the `clearElement` getter. */
|
|
408
|
+
"clearButtonVisible"?: OrVaadinDatePicker['clearButtonVisible'];
|
|
409
|
+
/** */
|
|
410
|
+
"dir"?: OrVaadinDatePicker['dir'];
|
|
411
|
+
/** */
|
|
412
|
+
"_positionTarget"?: OrVaadinDatePicker['_positionTarget'];
|
|
413
|
+
/** Set when the element is disabled */
|
|
414
|
+
"disabled"?: unknown;
|
|
415
|
+
/** Set when the element is disabled */
|
|
416
|
+
"undefined"?: unknown;
|
|
417
|
+
/** Set when the element has a value */
|
|
418
|
+
"has-value"?: unknown;
|
|
419
|
+
/** Set when the element has a label */
|
|
420
|
+
"has-label"?: unknown;
|
|
421
|
+
/** Set when the element has helper text or slot */
|
|
422
|
+
"has-helper"?: unknown;
|
|
423
|
+
/** Set when the element has an error message */
|
|
424
|
+
"has-error-message"?: unknown;
|
|
425
|
+
/** Set when the element has a slotted tooltip */
|
|
426
|
+
"has-tooltip"?: unknown;
|
|
427
|
+
/** Set when the element is invalid */
|
|
428
|
+
"invalid"?: unknown;
|
|
429
|
+
/** Set when the element is focused */
|
|
430
|
+
"focused"?: unknown;
|
|
431
|
+
/** Set when the element is keyboard focused */
|
|
432
|
+
"focus-ring"?: unknown;
|
|
433
|
+
/** Set when week numbers are shown in the calendar */
|
|
434
|
+
"week-numbers"?: unknown;
|
|
435
|
+
/** */
|
|
436
|
+
"<vaadin-date-picker>"?: unknown;
|
|
437
|
+
/** */
|
|
438
|
+
"<vaadin-date-picker-overlay-content>"?: unknown;
|
|
439
|
+
/** */
|
|
440
|
+
"<vaadin-date-picker-month-scroller>"?: unknown;
|
|
441
|
+
/** */
|
|
442
|
+
"<vaadin-date-picker-year-scroller>"?: unknown;
|
|
443
|
+
/** */
|
|
444
|
+
"<vaadin-date-picker-year>"?: unknown;
|
|
445
|
+
/** */
|
|
446
|
+
"<vaadin-month-calendar>"?: unknown;
|
|
447
|
+
/** Fullscreen mode years scroller toggle */
|
|
448
|
+
"years-toggle-button"?: unknown;
|
|
449
|
+
/** Toolbar with slotted buttons */
|
|
450
|
+
"toolbar"?: unknown;
|
|
451
|
+
/** */
|
|
452
|
+
"_inputElementValue"?: OrVaadinDatePicker['_inputElementValue'];
|
|
453
|
+
/** */
|
|
454
|
+
"_boundOnClick"?: OrVaadinDatePicker['_boundOnClick'];
|
|
455
|
+
/** */
|
|
456
|
+
"_boundOnScroll"?: OrVaadinDatePicker['_boundOnScroll'];
|
|
457
|
+
/** */
|
|
458
|
+
"_boundOnPaste"?: OrVaadinDatePicker['_boundOnPaste'];
|
|
459
|
+
/** */
|
|
460
|
+
"_boundOnDrop"?: OrVaadinDatePicker['_boundOnDrop'];
|
|
461
|
+
/** */
|
|
462
|
+
"_boundOnBeforeInput"?: OrVaadinDatePicker['_boundOnBeforeInput'];
|
|
463
|
+
/** */
|
|
464
|
+
"_fieldAriaController"?: OrVaadinDatePicker['_fieldAriaController'];
|
|
465
|
+
/** */
|
|
466
|
+
"_helperController"?: OrVaadinDatePicker['_helperController'];
|
|
467
|
+
/** */
|
|
468
|
+
"_errorController"?: OrVaadinDatePicker['_errorController'];
|
|
117
469
|
|
|
118
|
-
|
|
470
|
+
/** Fired when the user commits a value change. */
|
|
471
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
|
472
|
+
/** Fired when the user commits an unparsable value change and there is no change event. */
|
|
473
|
+
"onunparsable-change"?: (e: CustomEvent<Event>) => void;
|
|
474
|
+
/** */
|
|
475
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
476
|
+
/** Fired when the `invalid` property changes. */
|
|
477
|
+
"oninvalid-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
478
|
+
/** Fired when the `opened` property changes. */
|
|
479
|
+
"onopened-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
480
|
+
/** Fired when the `value` property changes. */
|
|
481
|
+
"onvalue-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
482
|
+
/** Fired whenever the field is validated. */
|
|
483
|
+
"onvalidated"?: (e: CustomEvent<CustomEvent>) => void;
|
|
119
484
|
}
|
|
120
485
|
|
|
121
486
|
|
|
122
487
|
export type OrVaadinDateTimePickerProps = {
|
|
488
|
+
/** The name of the control, which is submitted with the form data. */
|
|
489
|
+
"name"?: OrVaadinDateTimePicker['name'];
|
|
490
|
+
/** The value for this element.
|
|
491
|
+
|
|
492
|
+
Supported date time format is based on ISO 8601 (without a time zone designator):
|
|
493
|
+
- Minute precision `"YYYY-MM-DDThh:mm"` (default)
|
|
494
|
+
- Second precision `"YYYY-MM-DDThh:mm:ss"`
|
|
495
|
+
- Millisecond precision `"YYYY-MM-DDThh:mm:ss.fff"` */
|
|
496
|
+
"value"?: OrVaadinDateTimePicker['value'];
|
|
497
|
+
/** The earliest allowed value (date and time) that can be selected. All earlier values will be disabled.
|
|
498
|
+
|
|
499
|
+
Supported date time format is based on ISO 8601 (without a time zone designator):
|
|
500
|
+
- Minute precision `"YYYY-MM-DDThh:mm"`
|
|
501
|
+
- Second precision `"YYYY-MM-DDThh:mm:ss"`
|
|
502
|
+
- Millisecond precision `"YYYY-MM-DDThh:mm:ss.fff"` */
|
|
503
|
+
"min"?: OrVaadinDateTimePicker['min'];
|
|
504
|
+
/** The latest value (date and time) that can be selected. All later values will be disabled.
|
|
505
|
+
|
|
506
|
+
Supported date time format is based on ISO 8601 (without a time zone designator):
|
|
507
|
+
- Minute precision `"YYYY-MM-DDThh:mm"`
|
|
508
|
+
- Second precision `"YYYY-MM-DDThh:mm:ss"`
|
|
509
|
+
- Millisecond precision `"YYYY-MM-DDThh:mm:ss.fff"` */
|
|
510
|
+
"max"?: OrVaadinDateTimePicker['max'];
|
|
511
|
+
/** The earliest value that can be selected. All earlier values will be disabled. */
|
|
512
|
+
"__minDateTime"?: OrVaadinDateTimePicker['__minDateTime'];
|
|
513
|
+
/** The latest value that can be selected. All later values will be disabled. */
|
|
514
|
+
"__maxDateTime"?: OrVaadinDateTimePicker['__maxDateTime'];
|
|
515
|
+
/** A placeholder string for the date field. */
|
|
516
|
+
"datePlaceholder"?: OrVaadinDateTimePicker['datePlaceholder'];
|
|
517
|
+
/** A placeholder string for the time field. */
|
|
518
|
+
"timePlaceholder"?: OrVaadinDateTimePicker['timePlaceholder'];
|
|
519
|
+
/** Defines the time interval (in seconds) between the items displayed
|
|
520
|
+
in the time selection box. The default is 1 hour (i.e. `3600`).
|
|
521
|
+
|
|
522
|
+
It also configures the precision of the time part of the value string. By default
|
|
523
|
+
the component formats time values as `hh:mm` but setting a step value
|
|
524
|
+
lower than one minute or one second, format resolution changes to
|
|
525
|
+
`hh:mm:ss` and `hh:mm:ss.fff` respectively.
|
|
526
|
+
|
|
527
|
+
Unit must be set in seconds, and for correctly configuring intervals
|
|
528
|
+
in the dropdown, it need to evenly divide a day.
|
|
529
|
+
|
|
530
|
+
Note: it is possible to define step that is dividing an hour in inexact
|
|
531
|
+
fragments (i.e. 5760 seconds which equals 1 hour 36 minutes), but it is
|
|
532
|
+
not recommended to use it for better UX. */
|
|
533
|
+
"step"?: OrVaadinDateTimePicker['step'];
|
|
534
|
+
/** Date which should be visible in the date picker overlay when there is no value selected.
|
|
535
|
+
|
|
536
|
+
The same date formats as for the `value` property are supported but without the time part. */
|
|
537
|
+
"initialPosition"?: OrVaadinDateTimePicker['initialPosition'];
|
|
538
|
+
/** Set true to display ISO-8601 week numbers in the calendar. Notice that
|
|
539
|
+
displaying week numbers is only supported when `i18n.firstDayOfWeek`
|
|
540
|
+
is 1 (Monday). */
|
|
541
|
+
"showWeekNumbers"?: OrVaadinDateTimePicker['showWeekNumbers'];
|
|
542
|
+
/** Set to true to prevent the overlays from opening automatically. */
|
|
543
|
+
"autoOpenDisabled"?: OrVaadinDateTimePicker['autoOpenDisabled'];
|
|
544
|
+
/** Set to true to make this element read-only. */
|
|
545
|
+
"readonly"?: OrVaadinDateTimePicker['readonly'];
|
|
546
|
+
/** Specify that this control should have input focus when the page loads. */
|
|
547
|
+
"autofocus"?: OrVaadinDateTimePicker['autofocus'];
|
|
548
|
+
/** The current selected date time. */
|
|
549
|
+
"__selectedDateTime"?: OrVaadinDateTimePicker['__selectedDateTime'];
|
|
550
|
+
/** The current slotted date picker. */
|
|
551
|
+
"__datePicker"?: OrVaadinDateTimePicker['__datePicker'];
|
|
552
|
+
/** The current slotted time picker. */
|
|
553
|
+
"__timePicker"?: OrVaadinDateTimePicker['__timePicker'];
|
|
554
|
+
/** The object used to localize this component. To change the default
|
|
555
|
+
localization, replace this with an object that provides all properties, or
|
|
556
|
+
just the individual properties you want to change.
|
|
557
|
+
|
|
558
|
+
Should be overridden by subclasses to provide a custom JSDoc with the
|
|
559
|
+
default I18N properties. */
|
|
560
|
+
"i18n"?: OrVaadinDateTimePicker['i18n'];
|
|
561
|
+
/** */
|
|
562
|
+
"__effectiveI18n"?: OrVaadinDateTimePicker['__effectiveI18n'];
|
|
563
|
+
/** */
|
|
564
|
+
"dir"?: OrVaadinDateTimePicker['dir'];
|
|
565
|
+
/** Set when the element is disabled */
|
|
566
|
+
"disabled"?: unknown;
|
|
567
|
+
/** Set when the element is disabled */
|
|
568
|
+
"undefined"?: unknown;
|
|
569
|
+
/** Set when the element is focused */
|
|
570
|
+
"focused"?: unknown;
|
|
571
|
+
/** Set when the element is keyboard focused */
|
|
572
|
+
"focus-ring"?: unknown;
|
|
573
|
+
/** Set when the element is invalid */
|
|
574
|
+
"invalid"?: unknown;
|
|
575
|
+
/** Set when the element has a label */
|
|
576
|
+
"has-label"?: unknown;
|
|
577
|
+
/** Set when the element has a value */
|
|
578
|
+
"has-value"?: unknown;
|
|
579
|
+
/** Set when the element has helper text */
|
|
580
|
+
"has-helper"?: unknown;
|
|
581
|
+
/** Set when the element has an error message */
|
|
582
|
+
"has-error-message"?: unknown;
|
|
583
|
+
/** Set when the element has a slotted tooltip */
|
|
584
|
+
"has-tooltip"?: unknown;
|
|
585
|
+
/** */
|
|
586
|
+
"__defaultDateMinMaxValue"?: OrVaadinDateTimePicker['__defaultDateMinMaxValue'];
|
|
587
|
+
/** */
|
|
588
|
+
"__defaultTimeMinValue"?: OrVaadinDateTimePicker['__defaultTimeMinValue'];
|
|
589
|
+
/** */
|
|
590
|
+
"__defaultTimeMaxValue"?: OrVaadinDateTimePicker['__defaultTimeMaxValue'];
|
|
123
591
|
|
|
124
|
-
|
|
592
|
+
/** Fired when the user commits a value change. */
|
|
593
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
|
594
|
+
/** Fired when the user commits an unparsable or incomplete value change and there is no change event. */
|
|
595
|
+
"onunparsable-change"?: (e: CustomEvent<Event>) => void;
|
|
596
|
+
/** */
|
|
597
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
598
|
+
/** Fired when the `invalid` property changes. */
|
|
599
|
+
"oninvalid-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
600
|
+
/** Fired when the `value` property changes. */
|
|
601
|
+
"onvalue-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
602
|
+
/** Fired whenever the field is validated. */
|
|
603
|
+
"onvalidated"?: (e: CustomEvent<CustomEvent>) => void;
|
|
125
604
|
}
|
|
126
605
|
|
|
127
606
|
|
|
128
607
|
export type OrVaadinDialogProps = {
|
|
129
|
-
|
|
130
|
-
|
|
608
|
+
/** Set the width of the dialog.
|
|
609
|
+
If a unitless number is provided, pixels are assumed. */
|
|
610
|
+
"width"?: OrVaadinDialog['width'];
|
|
611
|
+
/** Set the height of the dialog.
|
|
612
|
+
If a unitless number is provided, pixels are assumed. */
|
|
613
|
+
"height"?: OrVaadinDialog['height'];
|
|
614
|
+
/** Set to true to enable repositioning the dialog by clicking and dragging.
|
|
615
|
+
|
|
616
|
+
By default, only the overlay area can be used to drag the element. But,
|
|
617
|
+
a child element can be marked as a draggable area by adding a
|
|
618
|
+
"`draggable`" class to it, this will by default make all of its children draggable also.
|
|
619
|
+
If you want a child element to be draggable
|
|
620
|
+
but still have its children non-draggable (by default), mark it with
|
|
621
|
+
"`draggable-leaf-only`" class name. */
|
|
622
|
+
"draggable"?: OrVaadinDialog['draggable'];
|
|
623
|
+
/** */
|
|
624
|
+
"_touchDevice"?: OrVaadinDialog['_touchDevice'];
|
|
625
|
+
/** */
|
|
626
|
+
"__dragHandleClassName"?: OrVaadinDialog['__dragHandleClassName'];
|
|
627
|
+
/** Set to true to enable resizing the dialog by dragging the corners and edges. */
|
|
628
|
+
"resizable"?: OrVaadinDialog['resizable'];
|
|
629
|
+
/** Custom function for rendering the content of the dialog.
|
|
630
|
+
Receives two arguments:
|
|
631
|
+
|
|
632
|
+
- `root` The root container DOM element. Append your content to it.
|
|
633
|
+
- `dialog` The reference to the `<vaadin-dialog>` element. */
|
|
634
|
+
"renderer"?: OrVaadinDialog['renderer'];
|
|
635
|
+
/** String used for rendering a dialog title.
|
|
636
|
+
|
|
637
|
+
If both `headerTitle` and `headerRenderer` are defined, the title
|
|
638
|
+
and the elements created by the renderer will be placed next to
|
|
639
|
+
each other, with the title coming first.
|
|
640
|
+
|
|
641
|
+
When `headerTitle` is set, the attribute `has-title` is set on the dialog. */
|
|
642
|
+
"headerTitle"?: OrVaadinDialog['headerTitle'];
|
|
643
|
+
/** Custom function for rendering the dialog header.
|
|
644
|
+
Receives two arguments:
|
|
645
|
+
|
|
646
|
+
- `root` The root container DOM element. Append your content to it.
|
|
647
|
+
- `dialog` The reference to the `<vaadin-dialog>` element.
|
|
648
|
+
|
|
649
|
+
If both `headerTitle` and `headerRenderer` are defined, the title
|
|
650
|
+
and the elements created by the renderer will be placed next to
|
|
651
|
+
each other, with the title coming first.
|
|
652
|
+
|
|
653
|
+
When `headerRenderer` is set, the attribute `has-header` is set on the dialog. */
|
|
654
|
+
"headerRenderer"?: OrVaadinDialog['headerRenderer'];
|
|
655
|
+
/** Custom function for rendering the dialog footer.
|
|
656
|
+
Receives two arguments:
|
|
657
|
+
|
|
658
|
+
- `root` The root container DOM element. Append your content to it.
|
|
659
|
+
- `dialog` The reference to the `<vaadin-dialog>` element.
|
|
660
|
+
|
|
661
|
+
When `footerRenderer` is set, the attribute `has-footer` is set on the dialog. */
|
|
662
|
+
"footerRenderer"?: OrVaadinDialog['footerRenderer'];
|
|
663
|
+
/** True if the dialog is visible and available for interaction. */
|
|
664
|
+
"opened"?: OrVaadinDialog['opened'];
|
|
665
|
+
/** Set to true to disable closing dialog on outside click */
|
|
666
|
+
"noCloseOnOutsideClick"?: OrVaadinDialog['noCloseOnOutsideClick'];
|
|
667
|
+
/** Set to true to disable closing dialog on Escape press */
|
|
668
|
+
"noCloseOnEsc"?: OrVaadinDialog['noCloseOnEsc'];
|
|
669
|
+
/** Set to true to remove backdrop and allow click events on background elements. */
|
|
670
|
+
"modeless"?: OrVaadinDialog['modeless'];
|
|
671
|
+
/** Set the distance of the dialog from the top of the viewport.
|
|
672
|
+
If a unitless number is provided, pixels are assumed.
|
|
673
|
+
|
|
674
|
+
Note that the dialog uses an internal container that has some
|
|
675
|
+
additional spacing, which can be overridden by the theme. */
|
|
676
|
+
"top"?: OrVaadinDialog['top'];
|
|
677
|
+
/** Set the distance of the dialog from the left of the viewport.
|
|
678
|
+
If a unitless number is provided, pixels are assumed.
|
|
679
|
+
|
|
680
|
+
Note that the dialog uses an internal container that has some
|
|
681
|
+
additional spacing, which can be overridden by the theme. */
|
|
682
|
+
"left"?: OrVaadinDialog['left'];
|
|
683
|
+
/** @deprecated Use standard `role` attribute on the dialog instead - The `role` attribute value to be set on the dialog. Defaults to "dialog". */
|
|
684
|
+
"overlayRole"?: OrVaadinDialog['overlayRole'];
|
|
685
|
+
/** */
|
|
686
|
+
"dir"?: OrVaadinDialog['dir'];
|
|
687
|
+
/** Set when the element has a title */
|
|
688
|
+
"has-title"?: unknown;
|
|
689
|
+
/** Set when the element has a title */
|
|
690
|
+
"undefined"?: unknown;
|
|
691
|
+
/** Set when the element has header renderer */
|
|
692
|
+
"has-header"?: unknown;
|
|
693
|
+
/** Set when the element has footer renderer */
|
|
694
|
+
"has-footer"?: unknown;
|
|
695
|
+
/** Set to `top`, `bottom`, none or both */
|
|
696
|
+
"overflow"?: unknown;
|
|
697
|
+
|
|
698
|
+
/** Fired when the dialog drag is finished. */
|
|
699
|
+
"ondragged"?: (e: CustomEvent<CustomEvent>) => void;
|
|
700
|
+
/** Fired when the dialog resize is finished. */
|
|
701
|
+
"onresize"?: (e: CustomEvent<CustomEvent>) => void;
|
|
702
|
+
/** Fired when the dialog is closed. */
|
|
703
|
+
"onclosed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
704
|
+
/** */
|
|
705
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
706
|
+
/** Fired when the `opened` property changes. */
|
|
707
|
+
"onopened-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
131
708
|
}
|
|
132
709
|
|
|
133
710
|
|
|
134
711
|
export type OrVaadinIconProps = {
|
|
712
|
+
/** */
|
|
713
|
+
"class"?: unknown;
|
|
714
|
+
/** */
|
|
715
|
+
"undefined"?: unknown;
|
|
716
|
+
/** The name of the icon to use. The name should be of the form:
|
|
717
|
+
`iconset_name:icon_name`. When using `vaadin-icons` it is possible
|
|
718
|
+
to omit the first part and only use `icon_name` as a value.
|
|
719
|
+
|
|
720
|
+
Setting the `icon` property updates the `svg` and `size` based on the
|
|
721
|
+
values provided by the corresponding `vaadin-iconset` element.
|
|
722
|
+
|
|
723
|
+
See also [`name`](#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`. */
|
|
724
|
+
"icon"?: OrVaadinIcon['icon'];
|
|
725
|
+
/** The SVG icon wrapped in a Lit template literal. */
|
|
726
|
+
"svg"?: OrVaadinIcon['svg'];
|
|
727
|
+
/** The SVG source to be loaded as the icon. It can be:
|
|
728
|
+
- an URL to a file containing the icon
|
|
729
|
+
- an URL in the format `/path/to/file.svg#objectID`, where the `objectID` refers to an ID attribute contained
|
|
730
|
+
inside the SVG referenced by the path. Note that the file needs to follow the same-origin policy.
|
|
731
|
+
- a string in the format `data:image/svg+xml,<svg>...</svg>`. You may need to use the `encodeURIComponent`
|
|
732
|
+
function for the SVG content passed */
|
|
733
|
+
"src"?: OrVaadinIcon['src'];
|
|
734
|
+
/** The symbol identifier that references an ID of an element contained in the SVG element assigned to the
|
|
735
|
+
`src` property */
|
|
736
|
+
"symbol"?: OrVaadinIcon['symbol'];
|
|
737
|
+
/** Class names defining an icon font and/or a specific glyph inside an icon font.
|
|
738
|
+
|
|
739
|
+
Example: "fa-solid fa-user" */
|
|
740
|
+
"iconClass"?: OrVaadinIcon['iconClass'];
|
|
741
|
+
/** A hexadecimal code point that specifies a glyph from an icon font.
|
|
742
|
+
|
|
743
|
+
Example: "e001" */
|
|
744
|
+
"char"?: OrVaadinIcon['char'];
|
|
745
|
+
/** A ligature name that specifies an icon from an icon font with support for ligatures.
|
|
746
|
+
|
|
747
|
+
Example: "home". */
|
|
748
|
+
"ligature"?: OrVaadinIcon['ligature'];
|
|
749
|
+
/** The font family to use for the font icon. */
|
|
750
|
+
"fontFamily"?: OrVaadinIcon['fontFamily'];
|
|
751
|
+
/** The size of an icon, used to set the `viewBox` attribute. */
|
|
752
|
+
"size"?: OrVaadinIcon['size'];
|
|
753
|
+
/** */
|
|
754
|
+
"__preserveAspectRatio"?: OrVaadinIcon['__preserveAspectRatio'];
|
|
755
|
+
/** */
|
|
756
|
+
"__useRef"?: OrVaadinIcon['__useRef'];
|
|
757
|
+
/** */
|
|
758
|
+
"__viewBox"?: OrVaadinIcon['__viewBox'];
|
|
759
|
+
/** */
|
|
760
|
+
"__fill"?: OrVaadinIcon['__fill'];
|
|
761
|
+
/** */
|
|
762
|
+
"__stroke"?: OrVaadinIcon['__stroke'];
|
|
763
|
+
/** */
|
|
764
|
+
"__strokeWidth"?: OrVaadinIcon['__strokeWidth'];
|
|
765
|
+
/** */
|
|
766
|
+
"__strokeLinecap"?: OrVaadinIcon['__strokeLinecap'];
|
|
767
|
+
/** */
|
|
768
|
+
"__strokeLinejoin"?: OrVaadinIcon['__strokeLinejoin'];
|
|
769
|
+
/** */
|
|
770
|
+
"dir"?: OrVaadinIcon['dir'];
|
|
771
|
+
/** Set when the icon has a slotted tooltip */
|
|
772
|
+
"has-tooltip"?: unknown;
|
|
773
|
+
/** */
|
|
774
|
+
"__fetch"?: OrVaadinIcon['__fetch'];
|
|
135
775
|
|
|
136
|
-
|
|
776
|
+
/** */
|
|
777
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
137
778
|
}
|
|
138
779
|
|
|
139
780
|
|
|
@@ -148,85 +789,1422 @@ Refer to InputType and OrVaadinInput.TEMPLATES for the supported types. */
|
|
|
148
789
|
|
|
149
790
|
|
|
150
791
|
export type OrVaadinMultiSelectComboBoxProps = {
|
|
151
|
-
|
|
152
|
-
|
|
792
|
+
/** Set to true to auto expand horizontally, causing input field to
|
|
793
|
+
grow until max width is reached. */
|
|
794
|
+
"autoExpandHorizontally"?: OrVaadinMultiSelectComboBox['autoExpandHorizontally'];
|
|
795
|
+
/** Set to true to not collapse selected items chips into the overflow
|
|
796
|
+
chip and instead always expand vertically, causing input field to
|
|
797
|
+
wrap into multiple lines when width is limited. */
|
|
798
|
+
"autoExpandVertically"?: OrVaadinMultiSelectComboBox['autoExpandVertically'];
|
|
799
|
+
/** A function used to generate CSS class names for dropdown
|
|
800
|
+
items and selected chips based on the item. The return
|
|
801
|
+
value should be the generated class name as a string, or
|
|
802
|
+
multiple class names separated by whitespace characters. */
|
|
803
|
+
"itemClassNameGenerator"?: OrVaadinMultiSelectComboBox['itemClassNameGenerator'];
|
|
804
|
+
/** Path for the id of the item, used to detect whether the item is selected. */
|
|
805
|
+
"itemIdPath"?: OrVaadinMultiSelectComboBox['itemIdPath'];
|
|
806
|
+
/** When true, filter string isn't cleared after selecting an item. */
|
|
807
|
+
"keepFilter"?: OrVaadinMultiSelectComboBox['keepFilter'];
|
|
808
|
+
/** True when loading items from the data provider, false otherwise. */
|
|
809
|
+
"loading"?: OrVaadinMultiSelectComboBox['loading'];
|
|
810
|
+
/** When present, it specifies that the field is read-only. */
|
|
811
|
+
"readonly"?: OrVaadinMultiSelectComboBox['readonly'];
|
|
812
|
+
/** The list of selected items.
|
|
813
|
+
Note: modifying the selected items creates a new array each time. */
|
|
814
|
+
"selectedItems"?: OrVaadinMultiSelectComboBox['selectedItems'];
|
|
815
|
+
/** When true, the user can input a value that is not present in the items list. */
|
|
816
|
+
"allowCustomValue"?: OrVaadinMultiSelectComboBox['allowCustomValue'];
|
|
817
|
+
/** A hint to the user of what can be entered in the control.
|
|
818
|
+
The placeholder will be only displayed in the case when
|
|
819
|
+
there is no item selected. */
|
|
820
|
+
"placeholder"?: OrVaadinMultiSelectComboBox['placeholder'];
|
|
821
|
+
/** Custom function for rendering the content of every item.
|
|
822
|
+
Receives three arguments:
|
|
823
|
+
|
|
824
|
+
- `root` The `<vaadin-multi-select-combo-box-item>` internal container DOM element.
|
|
825
|
+
- `comboBox` The reference to the `<vaadin-multi-select-combo-box>` element.
|
|
826
|
+
- `model` The object with the properties related with the rendered
|
|
827
|
+
item, contains:
|
|
828
|
+
- `model.index` The index of the rendered item.
|
|
829
|
+
- `model.item` The item. */
|
|
830
|
+
"renderer"?: OrVaadinMultiSelectComboBox['renderer'];
|
|
831
|
+
/** Set to true to group selected items at the top of the overlay. */
|
|
832
|
+
"selectedItemsOnTop"?: OrVaadinMultiSelectComboBox['selectedItemsOnTop'];
|
|
833
|
+
/** */
|
|
834
|
+
"value"?: OrVaadinMultiSelectComboBox['value'];
|
|
835
|
+
/** */
|
|
836
|
+
"_overflowItems"?: OrVaadinMultiSelectComboBox['_overflowItems'];
|
|
837
|
+
/** */
|
|
838
|
+
"_focusedChipIndex"?: OrVaadinMultiSelectComboBox['_focusedChipIndex'];
|
|
839
|
+
/** */
|
|
840
|
+
"_lastFilter"?: OrVaadinMultiSelectComboBox['_lastFilter'];
|
|
841
|
+
/** */
|
|
842
|
+
"_topGroup"?: OrVaadinMultiSelectComboBox['_topGroup'];
|
|
843
|
+
/** */
|
|
844
|
+
"_inputField"?: OrVaadinMultiSelectComboBox['_inputField'];
|
|
845
|
+
/** The object used to localize this component. To change the default
|
|
846
|
+
localization, replace this with an object that provides all properties, or
|
|
847
|
+
just the individual properties you want to change.
|
|
848
|
+
|
|
849
|
+
Should be overridden by subclasses to provide a custom JSDoc with the
|
|
850
|
+
default I18N properties. */
|
|
851
|
+
"i18n"?: OrVaadinMultiSelectComboBox['i18n'];
|
|
852
|
+
/** */
|
|
853
|
+
"__effectiveI18n"?: OrVaadinMultiSelectComboBox['__effectiveI18n'];
|
|
854
|
+
/** */
|
|
855
|
+
"dir"?: OrVaadinMultiSelectComboBox['dir'];
|
|
856
|
+
/** Set to a disabled element */
|
|
857
|
+
"disabled"?: unknown;
|
|
858
|
+
/** Set to a disabled element */
|
|
859
|
+
"undefined"?: unknown;
|
|
860
|
+
/** Set when the element has a value */
|
|
861
|
+
"has-value"?: unknown;
|
|
862
|
+
/** Set when the element has a label */
|
|
863
|
+
"has-label"?: unknown;
|
|
864
|
+
/** Set when the element has helper text or slot */
|
|
865
|
+
"has-helper"?: unknown;
|
|
866
|
+
/** Set when the element has an error message */
|
|
867
|
+
"has-error-message"?: unknown;
|
|
868
|
+
/** Set when the element has a slotted tooltip */
|
|
869
|
+
"has-tooltip"?: unknown;
|
|
870
|
+
/** Set when the element is invalid */
|
|
871
|
+
"invalid"?: unknown;
|
|
872
|
+
/** Set when the element is focused */
|
|
873
|
+
"focused"?: unknown;
|
|
874
|
+
/** Set when the element is keyboard focused */
|
|
875
|
+
"focus-ring"?: unknown;
|
|
876
|
+
/** Set when the dropdown is open */
|
|
877
|
+
"opened"?: unknown;
|
|
878
|
+
|
|
879
|
+
/** Fired when the user sets a custom value. */
|
|
880
|
+
"oncustom-value-set"?: (e: CustomEvent<CustomEvent>) => void;
|
|
881
|
+
/** Fired when the user commits a value change. */
|
|
882
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
|
883
|
+
/** */
|
|
884
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
885
|
+
/** Fired when the `filter` property changes. */
|
|
886
|
+
"onfilter-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
887
|
+
/** Fired when the `invalid` property changes. */
|
|
888
|
+
"oninvalid-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
889
|
+
/** Fired when the `opened` property changes. */
|
|
890
|
+
"onopened-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
891
|
+
/** Fired when the `selectedItems` property changes. */
|
|
892
|
+
"onselected-items-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
893
|
+
/** Fired whenever the field is validated. */
|
|
894
|
+
"onvalidated"?: (e: CustomEvent<CustomEvent>) => void;
|
|
153
895
|
}
|
|
154
896
|
|
|
155
897
|
|
|
156
898
|
export type OrVaadinNumberFieldProps = {
|
|
899
|
+
/** The minimum value of the field. */
|
|
900
|
+
"min"?: OrVaadinNumberField['min'];
|
|
901
|
+
/** The maximum value of the field. */
|
|
902
|
+
"max"?: OrVaadinNumberField['max'];
|
|
903
|
+
/** Specifies the allowed number intervals of the field. */
|
|
904
|
+
"step"?: OrVaadinNumberField['step'];
|
|
905
|
+
/** Set to true to show increase/decrease buttons. */
|
|
906
|
+
"stepButtonsVisible"?: OrVaadinNumberField['stepButtonsVisible'];
|
|
907
|
+
/** Whether the value of the control can be automatically completed by the browser.
|
|
908
|
+
List of available options at:
|
|
909
|
+
https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete */
|
|
910
|
+
"autocomplete"?: OrVaadinNumberField['autocomplete'];
|
|
911
|
+
/** This is a property supported by Safari that is used to control whether
|
|
912
|
+
autocorrection should be enabled when the user is entering/editing the text.
|
|
913
|
+
Possible values are:
|
|
914
|
+
on: Enable autocorrection.
|
|
915
|
+
off: Disable autocorrection. */
|
|
916
|
+
"autocorrect"?: OrVaadinNumberField['autocorrect'];
|
|
917
|
+
/** This is a property supported by Safari and Chrome that is used to control whether
|
|
918
|
+
autocapitalization should be enabled when the user is entering/editing the text.
|
|
919
|
+
Possible values are:
|
|
920
|
+
characters: Characters capitalization.
|
|
921
|
+
words: Words capitalization.
|
|
922
|
+
sentences: Sentences capitalization.
|
|
923
|
+
none: No capitalization. */
|
|
924
|
+
"autocapitalize"?: OrVaadinNumberField['autocapitalize'];
|
|
925
|
+
/** A pattern matched against individual characters the user inputs.
|
|
926
|
+
|
|
927
|
+
When set, the field will prevent:
|
|
928
|
+
- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`
|
|
929
|
+
- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`
|
|
930
|
+
- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`
|
|
931
|
+
|
|
932
|
+
For example, to allow entering only numbers and minus signs, use:
|
|
933
|
+
`allowedCharPattern = "[\\d-]"` */
|
|
934
|
+
"allowedCharPattern"?: OrVaadinNumberField['allowedCharPattern'];
|
|
935
|
+
/** If true, the input text gets fully selected when the field is focused using click or touch / tap. */
|
|
936
|
+
"autoselect"?: OrVaadinNumberField['autoselect'];
|
|
937
|
+
/** The name of this field. */
|
|
938
|
+
"name"?: OrVaadinNumberField['name'];
|
|
939
|
+
/** A hint to the user of what can be entered in the field. */
|
|
940
|
+
"placeholder"?: OrVaadinNumberField['placeholder'];
|
|
941
|
+
/** When present, it specifies that the field is read-only. */
|
|
942
|
+
"readonly"?: OrVaadinNumberField['readonly'];
|
|
943
|
+
/** The text usually displayed in a tooltip popup when the mouse is over the field. */
|
|
944
|
+
"title"?: OrVaadinNumberField['title'];
|
|
945
|
+
/** A target element to which ARIA attributes are set. */
|
|
946
|
+
"ariaTarget"?: OrVaadinNumberField['ariaTarget'];
|
|
947
|
+
/** Error to show when the field is invalid. */
|
|
948
|
+
"errorMessage"?: OrVaadinNumberField['errorMessage'];
|
|
949
|
+
/** String used for the helper text. */
|
|
950
|
+
"helperText"?: OrVaadinNumberField['helperText'];
|
|
951
|
+
/** String used to label the component to screen reader users. */
|
|
952
|
+
"accessibleName"?: OrVaadinNumberField['accessibleName'];
|
|
953
|
+
/** Id of the element used as label of the component to screen reader users. */
|
|
954
|
+
"accessibleNameRef"?: OrVaadinNumberField['accessibleNameRef'];
|
|
955
|
+
/** Set to true to display the clear icon which clears the input.
|
|
956
|
+
|
|
957
|
+
It is up to the component to choose where to place the clear icon:
|
|
958
|
+
in the Shadow DOM or in the light DOM. In any way, a reference to
|
|
959
|
+
the clear icon element should be provided via the `clearElement` getter. */
|
|
960
|
+
"clearButtonVisible"?: OrVaadinNumberField['clearButtonVisible'];
|
|
961
|
+
/** */
|
|
962
|
+
"dir"?: OrVaadinNumberField['dir'];
|
|
963
|
+
/** Set when the element is disabled */
|
|
964
|
+
"disabled"?: unknown;
|
|
965
|
+
/** Set when the element is disabled */
|
|
966
|
+
"undefined"?: unknown;
|
|
967
|
+
/** Set when the element has a value */
|
|
968
|
+
"has-value"?: unknown;
|
|
969
|
+
/** Set when the element has a label */
|
|
970
|
+
"has-label"?: unknown;
|
|
971
|
+
/** Set when the element has helper text or slot */
|
|
972
|
+
"has-helper"?: unknown;
|
|
973
|
+
/** Set when the element has an error message */
|
|
974
|
+
"has-error-message"?: unknown;
|
|
975
|
+
/** Set when the element has a slotted tooltip */
|
|
976
|
+
"has-tooltip"?: unknown;
|
|
977
|
+
/** Set when the element is invalid */
|
|
978
|
+
"invalid"?: unknown;
|
|
979
|
+
/** Temporarily set when invalid input is prevented */
|
|
980
|
+
"input-prevented"?: unknown;
|
|
981
|
+
/** Set when the element is focused */
|
|
982
|
+
"focused"?: unknown;
|
|
983
|
+
/** Set when the element is keyboard focused */
|
|
984
|
+
"focus-ring"?: unknown;
|
|
985
|
+
/** */
|
|
986
|
+
"change"?: unknown;
|
|
987
|
+
/** */
|
|
988
|
+
"unparsable-change"?: unknown;
|
|
989
|
+
/** */
|
|
990
|
+
"_inputElementValue"?: OrVaadinNumberField['_inputElementValue'];
|
|
991
|
+
/** */
|
|
992
|
+
"_boundOnPaste"?: OrVaadinNumberField['_boundOnPaste'];
|
|
993
|
+
/** */
|
|
994
|
+
"_boundOnDrop"?: OrVaadinNumberField['_boundOnDrop'];
|
|
995
|
+
/** */
|
|
996
|
+
"_boundOnBeforeInput"?: OrVaadinNumberField['_boundOnBeforeInput'];
|
|
997
|
+
/** */
|
|
998
|
+
"_fieldAriaController"?: OrVaadinNumberField['_fieldAriaController'];
|
|
999
|
+
/** */
|
|
1000
|
+
"_helperController"?: OrVaadinNumberField['_helperController'];
|
|
1001
|
+
/** */
|
|
1002
|
+
"_errorController"?: OrVaadinNumberField['_errorController'];
|
|
157
1003
|
|
|
158
1004
|
/** */
|
|
159
1005
|
"onsubmit"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1006
|
+
/** Fired when the user commits a value change. */
|
|
1007
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
|
1008
|
+
/** Fired when the user commits an unparsable value change and there is no change event. */
|
|
1009
|
+
"onunparsable-change"?: (e: CustomEvent<Event>) => void;
|
|
1010
|
+
/** */
|
|
1011
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1012
|
+
/** Fired when the value is changed by the user: on every typing keystroke, and the value is cleared using the clear button. */
|
|
1013
|
+
"oninput"?: (e: CustomEvent<Event>) => void;
|
|
1014
|
+
/** Fired when the `invalid` property changes. */
|
|
1015
|
+
"oninvalid-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1016
|
+
/** Fired when the `value` property changes. */
|
|
1017
|
+
"onvalue-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1018
|
+
/** Fired whenever the field is validated. */
|
|
1019
|
+
"onvalidated"?: (e: CustomEvent<CustomEvent>) => void;
|
|
160
1020
|
}
|
|
161
1021
|
|
|
162
1022
|
|
|
163
1023
|
export type OrVaadinPasswordFieldProps = {
|
|
1024
|
+
/** Set to true to hide the eye icon which toggles the password visibility. */
|
|
1025
|
+
"revealButtonHidden"?: OrVaadinPasswordField['revealButtonHidden'];
|
|
1026
|
+
/** True if the password is visible ([type=text]). */
|
|
1027
|
+
"passwordVisible"?: OrVaadinPasswordField['passwordVisible'];
|
|
1028
|
+
/** An object with translated strings used for localization.
|
|
1029
|
+
It has the following structure and default values:
|
|
1030
|
+
|
|
1031
|
+
```js
|
|
1032
|
+
{
|
|
1033
|
+
// Translation of the reveal icon button accessible label
|
|
1034
|
+
reveal: 'Show password'
|
|
1035
|
+
}
|
|
1036
|
+
``` */
|
|
1037
|
+
"i18n"?: OrVaadinPasswordField['i18n'];
|
|
1038
|
+
/** Set when the element is disabled */
|
|
1039
|
+
"disabled"?: unknown;
|
|
1040
|
+
/** Set when the element is disabled */
|
|
1041
|
+
"undefined"?: unknown;
|
|
1042
|
+
/** Set when the element has a value */
|
|
1043
|
+
"has-value"?: unknown;
|
|
1044
|
+
/** Set when the element has a label */
|
|
1045
|
+
"has-label"?: unknown;
|
|
1046
|
+
/** Set when the element has helper text or slot */
|
|
1047
|
+
"has-helper"?: unknown;
|
|
1048
|
+
/** Set when the element has an error message */
|
|
1049
|
+
"has-error-message"?: unknown;
|
|
1050
|
+
/** Set when the element has a slotted tooltip */
|
|
1051
|
+
"has-tooltip"?: unknown;
|
|
1052
|
+
/** Set when the element is invalid */
|
|
1053
|
+
"invalid"?: unknown;
|
|
1054
|
+
/** Temporarily set when invalid input is prevented */
|
|
1055
|
+
"input-prevented"?: unknown;
|
|
1056
|
+
/** Set when the element is focused */
|
|
1057
|
+
"focused"?: unknown;
|
|
1058
|
+
/** Set when the element is keyboard focused */
|
|
1059
|
+
"focus-ring"?: unknown;
|
|
1060
|
+
/** Set when the element is readonly */
|
|
1061
|
+
"readonly"?: OrVaadinPasswordField['readonly'];
|
|
1062
|
+
/** Set when the password is visible */
|
|
1063
|
+
"password-visible"?: unknown;
|
|
1064
|
+
/** */
|
|
1065
|
+
"allowedCharPattern"?: OrVaadinPasswordField['allowedCharPattern'];
|
|
1066
|
+
/** Maximum number of characters (in Unicode code points) that the user can enter. */
|
|
1067
|
+
"maxlength"?: OrVaadinPasswordField['maxlength'];
|
|
1068
|
+
/** Minimum number of characters (in Unicode code points) that the user can enter. */
|
|
1069
|
+
"minlength"?: OrVaadinPasswordField['minlength'];
|
|
1070
|
+
/** A regular expression that the value is checked against.
|
|
1071
|
+
The pattern must match the entire value, not just some subset. */
|
|
1072
|
+
"pattern"?: OrVaadinPasswordField['pattern'];
|
|
1073
|
+
/** Whether the value of the control can be automatically completed by the browser.
|
|
1074
|
+
List of available options at:
|
|
1075
|
+
https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete */
|
|
1076
|
+
"autocomplete"?: OrVaadinPasswordField['autocomplete'];
|
|
1077
|
+
/** This is a property supported by Safari that is used to control whether
|
|
1078
|
+
autocorrection should be enabled when the user is entering/editing the text.
|
|
1079
|
+
Possible values are:
|
|
1080
|
+
on: Enable autocorrection.
|
|
1081
|
+
off: Disable autocorrection. */
|
|
1082
|
+
"autocorrect"?: OrVaadinPasswordField['autocorrect'];
|
|
1083
|
+
/** This is a property supported by Safari and Chrome that is used to control whether
|
|
1084
|
+
autocapitalization should be enabled when the user is entering/editing the text.
|
|
1085
|
+
Possible values are:
|
|
1086
|
+
characters: Characters capitalization.
|
|
1087
|
+
words: Words capitalization.
|
|
1088
|
+
sentences: Sentences capitalization.
|
|
1089
|
+
none: No capitalization. */
|
|
1090
|
+
"autocapitalize"?: OrVaadinPasswordField['autocapitalize'];
|
|
1091
|
+
/** If true, the input text gets fully selected when the field is focused using click or touch / tap. */
|
|
1092
|
+
"autoselect"?: OrVaadinPasswordField['autoselect'];
|
|
1093
|
+
/** The name of this field. */
|
|
1094
|
+
"name"?: OrVaadinPasswordField['name'];
|
|
1095
|
+
/** A hint to the user of what can be entered in the field. */
|
|
1096
|
+
"placeholder"?: OrVaadinPasswordField['placeholder'];
|
|
1097
|
+
/** The text usually displayed in a tooltip popup when the mouse is over the field. */
|
|
1098
|
+
"title"?: OrVaadinPasswordField['title'];
|
|
1099
|
+
/** A target element to which ARIA attributes are set. */
|
|
1100
|
+
"ariaTarget"?: OrVaadinPasswordField['ariaTarget'];
|
|
1101
|
+
/** Error to show when the field is invalid. */
|
|
1102
|
+
"errorMessage"?: OrVaadinPasswordField['errorMessage'];
|
|
1103
|
+
/** String used for the helper text. */
|
|
1104
|
+
"helperText"?: OrVaadinPasswordField['helperText'];
|
|
1105
|
+
/** String used to label the component to screen reader users. */
|
|
1106
|
+
"accessibleName"?: OrVaadinPasswordField['accessibleName'];
|
|
1107
|
+
/** Id of the element used as label of the component to screen reader users. */
|
|
1108
|
+
"accessibleNameRef"?: OrVaadinPasswordField['accessibleNameRef'];
|
|
1109
|
+
/** Set to true to display the clear icon which clears the input.
|
|
1110
|
+
|
|
1111
|
+
It is up to the component to choose where to place the clear icon:
|
|
1112
|
+
in the Shadow DOM or in the light DOM. In any way, a reference to
|
|
1113
|
+
the clear icon element should be provided via the `clearElement` getter. */
|
|
1114
|
+
"clearButtonVisible"?: OrVaadinPasswordField['clearButtonVisible'];
|
|
1115
|
+
/** */
|
|
1116
|
+
"dir"?: OrVaadinPasswordField['dir'];
|
|
1117
|
+
/** */
|
|
1118
|
+
"__boundRevealButtonClick"?: OrVaadinPasswordField['__boundRevealButtonClick'];
|
|
1119
|
+
/** */
|
|
1120
|
+
"__boundRevealButtonMouseDown"?: OrVaadinPasswordField['__boundRevealButtonMouseDown'];
|
|
1121
|
+
/** */
|
|
1122
|
+
"__lastChange"?: OrVaadinPasswordField['__lastChange'];
|
|
1123
|
+
/** */
|
|
1124
|
+
"_boundOnPaste"?: OrVaadinPasswordField['_boundOnPaste'];
|
|
1125
|
+
/** */
|
|
1126
|
+
"_boundOnDrop"?: OrVaadinPasswordField['_boundOnDrop'];
|
|
1127
|
+
/** */
|
|
1128
|
+
"_boundOnBeforeInput"?: OrVaadinPasswordField['_boundOnBeforeInput'];
|
|
1129
|
+
/** */
|
|
1130
|
+
"_fieldAriaController"?: OrVaadinPasswordField['_fieldAriaController'];
|
|
1131
|
+
/** */
|
|
1132
|
+
"_helperController"?: OrVaadinPasswordField['_helperController'];
|
|
1133
|
+
/** */
|
|
1134
|
+
"_errorController"?: OrVaadinPasswordField['_errorController'];
|
|
164
1135
|
|
|
165
1136
|
/** */
|
|
166
1137
|
"onsubmit"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1138
|
+
/** Fired when the user commits a value change. */
|
|
1139
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
|
1140
|
+
/** Fired when the value is changed by the user: on every typing keystroke, and the value is cleared using the clear button. */
|
|
1141
|
+
"oninput"?: (e: CustomEvent<Event>) => void;
|
|
1142
|
+
/** Fired when the `invalid` property changes. */
|
|
1143
|
+
"oninvalid-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1144
|
+
/** Fired when the `value` property changes. */
|
|
1145
|
+
"onvalue-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1146
|
+
/** Fired whenever the field is validated. */
|
|
1147
|
+
"onvalidated"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1148
|
+
/** */
|
|
1149
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
167
1150
|
}
|
|
168
1151
|
|
|
169
1152
|
|
|
170
1153
|
export type OrVaadinRadioGroupProps = {
|
|
1154
|
+
/** The name of the control, which is submitted with the form data. */
|
|
1155
|
+
"name"?: OrVaadinRadioGroup['name'];
|
|
1156
|
+
/** The value of the radio group. */
|
|
1157
|
+
"value"?: OrVaadinRadioGroup['value'];
|
|
1158
|
+
/** When present, the user cannot modify the value of the radio group.
|
|
1159
|
+
The property works similarly to the `disabled` property.
|
|
1160
|
+
While the `disabled` property disables all radio buttons inside the group,
|
|
1161
|
+
the `readonly` property disables only unchecked ones. */
|
|
1162
|
+
"readonly"?: OrVaadinRadioGroup['readonly'];
|
|
1163
|
+
/** */
|
|
1164
|
+
"_fieldName"?: OrVaadinRadioGroup['_fieldName'];
|
|
1165
|
+
/** A target element to which ARIA attributes are set. */
|
|
1166
|
+
"ariaTarget"?: OrVaadinRadioGroup['ariaTarget'];
|
|
1167
|
+
/** Error to show when the field is invalid. */
|
|
1168
|
+
"errorMessage"?: OrVaadinRadioGroup['errorMessage'];
|
|
1169
|
+
/** String used for the helper text. */
|
|
1170
|
+
"helperText"?: OrVaadinRadioGroup['helperText'];
|
|
1171
|
+
/** String used to label the component to screen reader users. */
|
|
1172
|
+
"accessibleName"?: OrVaadinRadioGroup['accessibleName'];
|
|
1173
|
+
/** Id of the element used as label of the component to screen reader users. */
|
|
1174
|
+
"accessibleNameRef"?: OrVaadinRadioGroup['accessibleNameRef'];
|
|
1175
|
+
/** */
|
|
1176
|
+
"dir"?: OrVaadinRadioGroup['dir'];
|
|
1177
|
+
/** Set when the element is disabled */
|
|
1178
|
+
"disabled"?: unknown;
|
|
1179
|
+
/** Set when the element is disabled */
|
|
1180
|
+
"undefined"?: unknown;
|
|
1181
|
+
/** Set when the element is invalid */
|
|
1182
|
+
"invalid"?: unknown;
|
|
1183
|
+
/** Set when the element is focused */
|
|
1184
|
+
"focused"?: unknown;
|
|
1185
|
+
/** Set when the element has a label */
|
|
1186
|
+
"has-label"?: unknown;
|
|
1187
|
+
/** Set when the element has a value */
|
|
1188
|
+
"has-value"?: unknown;
|
|
1189
|
+
/** Set when the element has helper text */
|
|
1190
|
+
"has-helper"?: unknown;
|
|
1191
|
+
/** Set when the element has an error message */
|
|
1192
|
+
"has-error-message"?: unknown;
|
|
1193
|
+
/** Set when the element has a slotted tooltip */
|
|
1194
|
+
"has-tooltip"?: unknown;
|
|
1195
|
+
/** */
|
|
1196
|
+
"_tooltipController"?: OrVaadinRadioGroup['_tooltipController'];
|
|
1197
|
+
/** */
|
|
1198
|
+
"_fieldAriaController"?: OrVaadinRadioGroup['_fieldAriaController'];
|
|
1199
|
+
/** */
|
|
1200
|
+
"_helperController"?: OrVaadinRadioGroup['_helperController'];
|
|
1201
|
+
/** */
|
|
1202
|
+
"_errorController"?: OrVaadinRadioGroup['_errorController'];
|
|
171
1203
|
|
|
172
|
-
|
|
1204
|
+
/** */
|
|
1205
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1206
|
+
/** Fired when the `invalid` property changes. */
|
|
1207
|
+
"oninvalid-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1208
|
+
/** Fired when the `value` property changes. */
|
|
1209
|
+
"onvalue-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1210
|
+
/** Fired whenever the field is validated. */
|
|
1211
|
+
"onvalidated"?: (e: CustomEvent<CustomEvent>) => void;
|
|
173
1212
|
}
|
|
174
1213
|
|
|
175
1214
|
|
|
176
1215
|
export type OrVaadinSelectProps = {
|
|
1216
|
+
/** An array containing items that will be rendered as the options of the select.
|
|
1217
|
+
|
|
1218
|
+
#### Example
|
|
1219
|
+
```js
|
|
1220
|
+
select.items = [
|
|
1221
|
+
{ label: 'Most recent first', value: 'recent' },
|
|
1222
|
+
{ component: 'hr' },
|
|
1223
|
+
{ label: 'Rating: low to high', value: 'rating-asc', className: 'asc' },
|
|
1224
|
+
{ label: 'Rating: high to low', value: 'rating-desc', className: 'desc' },
|
|
1225
|
+
{ component: 'hr' },
|
|
1226
|
+
{ label: 'Price: low to high', value: 'price-asc', disabled: true },
|
|
1227
|
+
{ label: 'Price: high to low', value: 'price-desc', disabled: true }
|
|
1228
|
+
];
|
|
1229
|
+
```
|
|
1230
|
+
|
|
1231
|
+
Note: each item is rendered by default as the internal `<vaadin-select-item>` that is an extension of `<vaadin-item>`.
|
|
1232
|
+
To render the item with a custom component, provide a tag name by the `component` property. */
|
|
1233
|
+
"items"?: OrVaadinSelect['items'];
|
|
1234
|
+
/** Set when the select is open */
|
|
1235
|
+
"opened"?: OrVaadinSelect['opened'];
|
|
1236
|
+
/** Custom function for rendering the content of the `<vaadin-select>`.
|
|
1237
|
+
Receives two arguments:
|
|
1238
|
+
|
|
1239
|
+
- `root` The internal container DOM element. Append your content to it.
|
|
1240
|
+
- `select` The reference to the `<vaadin-select>` element. */
|
|
1241
|
+
"renderer"?: OrVaadinSelect['renderer'];
|
|
1242
|
+
/** The `value` property of the selected item, or an empty string
|
|
1243
|
+
if no item is selected.
|
|
1244
|
+
On change or initialization, the component finds the item which matches the
|
|
1245
|
+
value and displays it.
|
|
1246
|
+
If no value is provided to the component, it selects the first item without
|
|
1247
|
+
value or empty value.
|
|
1248
|
+
Hint: If you do not want to select any item by default, you can either set all
|
|
1249
|
+
the values of inner vaadin-items, or set the vaadin-select value to
|
|
1250
|
+
an inexistent value in the items list. */
|
|
1251
|
+
"value"?: OrVaadinSelect['value'];
|
|
1252
|
+
/** The name of this element. */
|
|
1253
|
+
"name"?: OrVaadinSelect['name'];
|
|
1254
|
+
/** A hint to the user of what can be entered in the control.
|
|
1255
|
+
The placeholder will be displayed in the case that there
|
|
1256
|
+
is no item selected, or the selected item has an empty
|
|
1257
|
+
string label, or the selected item has no label and it's
|
|
1258
|
+
DOM content is empty. */
|
|
1259
|
+
"placeholder"?: OrVaadinSelect['placeholder'];
|
|
1260
|
+
/** When present, it specifies that the element is read-only. */
|
|
1261
|
+
"readonly"?: OrVaadinSelect['readonly'];
|
|
1262
|
+
/** Defines whether the overlay should overlap the target element
|
|
1263
|
+
in the y-axis, or be positioned right above/below it. */
|
|
1264
|
+
"noVerticalOverlap"?: OrVaadinSelect['noVerticalOverlap'];
|
|
1265
|
+
/** */
|
|
1266
|
+
"_phone"?: OrVaadinSelect['_phone'];
|
|
1267
|
+
/** */
|
|
1268
|
+
"_phoneMediaQuery"?: OrVaadinSelect['_phoneMediaQuery'];
|
|
1269
|
+
/** */
|
|
1270
|
+
"_inputContainer"?: OrVaadinSelect['_inputContainer'];
|
|
1271
|
+
/** */
|
|
1272
|
+
"_items"?: OrVaadinSelect['_items'];
|
|
1273
|
+
/** A target element to which ARIA attributes are set. */
|
|
1274
|
+
"ariaTarget"?: OrVaadinSelect['ariaTarget'];
|
|
1275
|
+
/** Error to show when the field is invalid. */
|
|
1276
|
+
"errorMessage"?: OrVaadinSelect['errorMessage'];
|
|
1277
|
+
/** String used for the helper text. */
|
|
1278
|
+
"helperText"?: OrVaadinSelect['helperText'];
|
|
1279
|
+
/** String used to label the component to screen reader users. */
|
|
1280
|
+
"accessibleName"?: OrVaadinSelect['accessibleName'];
|
|
1281
|
+
/** Id of the element used as label of the component to screen reader users. */
|
|
1282
|
+
"accessibleNameRef"?: OrVaadinSelect['accessibleNameRef'];
|
|
1283
|
+
/** */
|
|
1284
|
+
"dir"?: OrVaadinSelect['dir'];
|
|
1285
|
+
/** Set when the element is disabled */
|
|
1286
|
+
"disabled"?: unknown;
|
|
1287
|
+
/** Set when the element is disabled */
|
|
1288
|
+
"undefined"?: unknown;
|
|
1289
|
+
/** Set when the element has a value */
|
|
1290
|
+
"has-value"?: unknown;
|
|
1291
|
+
/** Set when the element has a label */
|
|
1292
|
+
"has-label"?: unknown;
|
|
1293
|
+
/** Set when the element has helper text or slot */
|
|
1294
|
+
"has-helper"?: unknown;
|
|
1295
|
+
/** Set when the element has an error message */
|
|
1296
|
+
"has-error-message"?: unknown;
|
|
1297
|
+
/** Set when the element is invalid */
|
|
1298
|
+
"invalid"?: unknown;
|
|
1299
|
+
/** Set when the element is focused */
|
|
1300
|
+
"focused"?: unknown;
|
|
1301
|
+
/** Set when the element is keyboard focused */
|
|
1302
|
+
"focus-ring"?: unknown;
|
|
1303
|
+
/** Set when the overlay is shown in phone mode */
|
|
1304
|
+
"phone"?: unknown;
|
|
1305
|
+
/** */
|
|
1306
|
+
"<vaadin-select>"?: unknown;
|
|
1307
|
+
/** */
|
|
1308
|
+
"<vaadin-select-value-button>"?: unknown;
|
|
1309
|
+
/** */
|
|
1310
|
+
"<vaadin-button>"?: unknown;
|
|
1311
|
+
/** */
|
|
1312
|
+
"<vaadin-select-list-box>"?: unknown;
|
|
1313
|
+
/** */
|
|
1314
|
+
"<vaadin-list-box>"?: unknown;
|
|
1315
|
+
/** */
|
|
1316
|
+
"<vaadin-select-item>"?: unknown;
|
|
1317
|
+
/** */
|
|
1318
|
+
"<vaadin-item>"?: unknown;
|
|
1319
|
+
/** */
|
|
1320
|
+
"_itemId"?: OrVaadinSelect['_itemId'];
|
|
1321
|
+
/** */
|
|
1322
|
+
"_srLabelController"?: OrVaadinSelect['_srLabelController'];
|
|
1323
|
+
/** */
|
|
1324
|
+
"slotName"?: OrVaadinSelect['slotName'];
|
|
1325
|
+
/** */
|
|
1326
|
+
"_fieldAriaController"?: OrVaadinSelect['_fieldAriaController'];
|
|
1327
|
+
/** */
|
|
1328
|
+
"_helperController"?: OrVaadinSelect['_helperController'];
|
|
1329
|
+
/** */
|
|
1330
|
+
"_errorController"?: OrVaadinSelect['_errorController'];
|
|
177
1331
|
|
|
178
|
-
|
|
1332
|
+
/** Fired when the user commits a value change. */
|
|
1333
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
|
1334
|
+
/** */
|
|
1335
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1336
|
+
/** Fired when the `invalid` property changes. */
|
|
1337
|
+
"oninvalid-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1338
|
+
/** Fired when the `opened` property changes. */
|
|
1339
|
+
"onopened-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1340
|
+
/** Fired when the `value` property changes. */
|
|
1341
|
+
"onvalue-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1342
|
+
/** Fired whenever the field is validated. */
|
|
1343
|
+
"onvalidated"?: (e: CustomEvent<CustomEvent>) => void;
|
|
179
1344
|
}
|
|
180
1345
|
|
|
181
1346
|
|
|
182
1347
|
export type OrVaadinTextAreaProps = {
|
|
1348
|
+
/** Maximum number of characters (in Unicode code points) that the user can enter. */
|
|
1349
|
+
"maxlength"?: OrVaadinTextArea['maxlength'];
|
|
1350
|
+
/** Minimum number of characters (in Unicode code points) that the user can enter. */
|
|
1351
|
+
"minlength"?: OrVaadinTextArea['minlength'];
|
|
1352
|
+
/** A regular expression that the value is checked against.
|
|
1353
|
+
The pattern must match the entire value, not just some subset. */
|
|
1354
|
+
"pattern"?: OrVaadinTextArea['pattern'];
|
|
1355
|
+
/** Minimum number of rows to show. Default is two rows.
|
|
1356
|
+
|
|
1357
|
+
When using a custom slotted textarea, the minimum number of rows are not applied for backwards compatibility. */
|
|
1358
|
+
"minRows"?: OrVaadinTextArea['minRows'];
|
|
1359
|
+
/** Maximum number of rows to expand to before the text area starts scrolling. This effectively sets a max-height
|
|
1360
|
+
on the `input-field` part. By default, it is not set, and the text area grows with the content without
|
|
1361
|
+
constraints. */
|
|
1362
|
+
"maxRows"?: OrVaadinTextArea['maxRows'];
|
|
1363
|
+
/** Whether the value of the control can be automatically completed by the browser.
|
|
1364
|
+
List of available options at:
|
|
1365
|
+
https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete */
|
|
1366
|
+
"autocomplete"?: OrVaadinTextArea['autocomplete'];
|
|
1367
|
+
/** This is a property supported by Safari that is used to control whether
|
|
1368
|
+
autocorrection should be enabled when the user is entering/editing the text.
|
|
1369
|
+
Possible values are:
|
|
1370
|
+
on: Enable autocorrection.
|
|
1371
|
+
off: Disable autocorrection. */
|
|
1372
|
+
"autocorrect"?: OrVaadinTextArea['autocorrect'];
|
|
1373
|
+
/** This is a property supported by Safari and Chrome that is used to control whether
|
|
1374
|
+
autocapitalization should be enabled when the user is entering/editing the text.
|
|
1375
|
+
Possible values are:
|
|
1376
|
+
characters: Characters capitalization.
|
|
1377
|
+
words: Words capitalization.
|
|
1378
|
+
sentences: Sentences capitalization.
|
|
1379
|
+
none: No capitalization. */
|
|
1380
|
+
"autocapitalize"?: OrVaadinTextArea['autocapitalize'];
|
|
1381
|
+
/** A pattern matched against individual characters the user inputs.
|
|
1382
|
+
|
|
1383
|
+
When set, the field will prevent:
|
|
1384
|
+
- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`
|
|
1385
|
+
- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`
|
|
1386
|
+
- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`
|
|
1387
|
+
|
|
1388
|
+
For example, to allow entering only numbers and minus signs, use:
|
|
1389
|
+
`allowedCharPattern = "[\\d-]"` */
|
|
1390
|
+
"allowedCharPattern"?: OrVaadinTextArea['allowedCharPattern'];
|
|
1391
|
+
/** If true, the input text gets fully selected when the field is focused using click or touch / tap. */
|
|
1392
|
+
"autoselect"?: OrVaadinTextArea['autoselect'];
|
|
1393
|
+
/** The name of this field. */
|
|
1394
|
+
"name"?: OrVaadinTextArea['name'];
|
|
1395
|
+
/** A hint to the user of what can be entered in the field. */
|
|
1396
|
+
"placeholder"?: OrVaadinTextArea['placeholder'];
|
|
1397
|
+
/** When present, it specifies that the field is read-only. */
|
|
1398
|
+
"readonly"?: OrVaadinTextArea['readonly'];
|
|
1399
|
+
/** The text usually displayed in a tooltip popup when the mouse is over the field. */
|
|
1400
|
+
"title"?: OrVaadinTextArea['title'];
|
|
1401
|
+
/** A target element to which ARIA attributes are set. */
|
|
1402
|
+
"ariaTarget"?: OrVaadinTextArea['ariaTarget'];
|
|
1403
|
+
/** Error to show when the field is invalid. */
|
|
1404
|
+
"errorMessage"?: OrVaadinTextArea['errorMessage'];
|
|
1405
|
+
/** String used for the helper text. */
|
|
1406
|
+
"helperText"?: OrVaadinTextArea['helperText'];
|
|
1407
|
+
/** String used to label the component to screen reader users. */
|
|
1408
|
+
"accessibleName"?: OrVaadinTextArea['accessibleName'];
|
|
1409
|
+
/** Id of the element used as label of the component to screen reader users. */
|
|
1410
|
+
"accessibleNameRef"?: OrVaadinTextArea['accessibleNameRef'];
|
|
1411
|
+
/** Set to true to display the clear icon which clears the input.
|
|
1412
|
+
|
|
1413
|
+
It is up to the component to choose where to place the clear icon:
|
|
1414
|
+
in the Shadow DOM or in the light DOM. In any way, a reference to
|
|
1415
|
+
the clear icon element should be provided via the `clearElement` getter. */
|
|
1416
|
+
"clearButtonVisible"?: OrVaadinTextArea['clearButtonVisible'];
|
|
1417
|
+
/** */
|
|
1418
|
+
"dir"?: OrVaadinTextArea['dir'];
|
|
1419
|
+
/** Set when the element is disabled */
|
|
1420
|
+
"disabled"?: unknown;
|
|
1421
|
+
/** Set when the element is disabled */
|
|
1422
|
+
"undefined"?: unknown;
|
|
1423
|
+
/** Set when the element has a value */
|
|
1424
|
+
"has-value"?: unknown;
|
|
1425
|
+
/** Set when the element has a label */
|
|
1426
|
+
"has-label"?: unknown;
|
|
1427
|
+
/** Set when the element has helper text or slot */
|
|
1428
|
+
"has-helper"?: unknown;
|
|
1429
|
+
/** Set when the element has an error message */
|
|
1430
|
+
"has-error-message"?: unknown;
|
|
1431
|
+
/** Set when the element has a slotted tooltip */
|
|
1432
|
+
"has-tooltip"?: unknown;
|
|
1433
|
+
/** Set when the element is invalid */
|
|
1434
|
+
"invalid"?: unknown;
|
|
1435
|
+
/** Temporarily set when invalid input is prevented */
|
|
1436
|
+
"input-prevented"?: unknown;
|
|
1437
|
+
/** Set when the element is focused */
|
|
1438
|
+
"focused"?: unknown;
|
|
1439
|
+
/** Set when the element is keyboard focused */
|
|
1440
|
+
"focus-ring"?: unknown;
|
|
1441
|
+
/** */
|
|
1442
|
+
"_boundOnPaste"?: OrVaadinTextArea['_boundOnPaste'];
|
|
1443
|
+
/** */
|
|
1444
|
+
"_boundOnDrop"?: OrVaadinTextArea['_boundOnDrop'];
|
|
1445
|
+
/** */
|
|
1446
|
+
"_boundOnBeforeInput"?: OrVaadinTextArea['_boundOnBeforeInput'];
|
|
1447
|
+
/** */
|
|
1448
|
+
"_fieldAriaController"?: OrVaadinTextArea['_fieldAriaController'];
|
|
1449
|
+
/** */
|
|
1450
|
+
"_helperController"?: OrVaadinTextArea['_helperController'];
|
|
1451
|
+
/** */
|
|
1452
|
+
"_errorController"?: OrVaadinTextArea['_errorController'];
|
|
183
1453
|
|
|
184
1454
|
/** */
|
|
185
1455
|
"onsubmit"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1456
|
+
/** */
|
|
1457
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1458
|
+
/** Fired when the value is changed by the user: on every typing keystroke, and the value is cleared using the clear button. */
|
|
1459
|
+
"oninput"?: (e: CustomEvent<Event>) => void;
|
|
1460
|
+
/** Fired when the user commits a value change. */
|
|
1461
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
|
1462
|
+
/** Fired when the `invalid` property changes. */
|
|
1463
|
+
"oninvalid-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1464
|
+
/** Fired when the `value` property changes. */
|
|
1465
|
+
"onvalue-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1466
|
+
/** Fired whenever the field is validated. */
|
|
1467
|
+
"onvalidated"?: (e: CustomEvent<CustomEvent>) => void;
|
|
186
1468
|
}
|
|
187
1469
|
|
|
188
1470
|
|
|
189
1471
|
export type OrVaadinTextFieldProps = {
|
|
1472
|
+
/** Maximum number of characters (in Unicode code points) that the user can enter. */
|
|
1473
|
+
"maxlength"?: OrVaadinTextField['maxlength'];
|
|
1474
|
+
/** Minimum number of characters (in Unicode code points) that the user can enter. */
|
|
1475
|
+
"minlength"?: OrVaadinTextField['minlength'];
|
|
1476
|
+
/** A regular expression that the value is checked against.
|
|
1477
|
+
The pattern must match the entire value, not just some subset. */
|
|
1478
|
+
"pattern"?: OrVaadinTextField['pattern'];
|
|
1479
|
+
/** Whether the value of the control can be automatically completed by the browser.
|
|
1480
|
+
List of available options at:
|
|
1481
|
+
https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete */
|
|
1482
|
+
"autocomplete"?: OrVaadinTextField['autocomplete'];
|
|
1483
|
+
/** This is a property supported by Safari that is used to control whether
|
|
1484
|
+
autocorrection should be enabled when the user is entering/editing the text.
|
|
1485
|
+
Possible values are:
|
|
1486
|
+
on: Enable autocorrection.
|
|
1487
|
+
off: Disable autocorrection. */
|
|
1488
|
+
"autocorrect"?: OrVaadinTextField['autocorrect'];
|
|
1489
|
+
/** This is a property supported by Safari and Chrome that is used to control whether
|
|
1490
|
+
autocapitalization should be enabled when the user is entering/editing the text.
|
|
1491
|
+
Possible values are:
|
|
1492
|
+
characters: Characters capitalization.
|
|
1493
|
+
words: Words capitalization.
|
|
1494
|
+
sentences: Sentences capitalization.
|
|
1495
|
+
none: No capitalization. */
|
|
1496
|
+
"autocapitalize"?: OrVaadinTextField['autocapitalize'];
|
|
1497
|
+
/** A pattern matched against individual characters the user inputs.
|
|
1498
|
+
|
|
1499
|
+
When set, the field will prevent:
|
|
1500
|
+
- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`
|
|
1501
|
+
- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`
|
|
1502
|
+
- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`
|
|
1503
|
+
|
|
1504
|
+
For example, to allow entering only numbers and minus signs, use:
|
|
1505
|
+
`allowedCharPattern = "[\\d-]"` */
|
|
1506
|
+
"allowedCharPattern"?: OrVaadinTextField['allowedCharPattern'];
|
|
1507
|
+
/** If true, the input text gets fully selected when the field is focused using click or touch / tap. */
|
|
1508
|
+
"autoselect"?: OrVaadinTextField['autoselect'];
|
|
1509
|
+
/** The name of this field. */
|
|
1510
|
+
"name"?: OrVaadinTextField['name'];
|
|
1511
|
+
/** A hint to the user of what can be entered in the field. */
|
|
1512
|
+
"placeholder"?: OrVaadinTextField['placeholder'];
|
|
1513
|
+
/** When present, it specifies that the field is read-only. */
|
|
1514
|
+
"readonly"?: OrVaadinTextField['readonly'];
|
|
1515
|
+
/** The text usually displayed in a tooltip popup when the mouse is over the field. */
|
|
1516
|
+
"title"?: OrVaadinTextField['title'];
|
|
1517
|
+
/** A target element to which ARIA attributes are set. */
|
|
1518
|
+
"ariaTarget"?: OrVaadinTextField['ariaTarget'];
|
|
1519
|
+
/** Error to show when the field is invalid. */
|
|
1520
|
+
"errorMessage"?: OrVaadinTextField['errorMessage'];
|
|
1521
|
+
/** String used for the helper text. */
|
|
1522
|
+
"helperText"?: OrVaadinTextField['helperText'];
|
|
1523
|
+
/** String used to label the component to screen reader users. */
|
|
1524
|
+
"accessibleName"?: OrVaadinTextField['accessibleName'];
|
|
1525
|
+
/** Id of the element used as label of the component to screen reader users. */
|
|
1526
|
+
"accessibleNameRef"?: OrVaadinTextField['accessibleNameRef'];
|
|
1527
|
+
/** Set to true to display the clear icon which clears the input.
|
|
1528
|
+
|
|
1529
|
+
It is up to the component to choose where to place the clear icon:
|
|
1530
|
+
in the Shadow DOM or in the light DOM. In any way, a reference to
|
|
1531
|
+
the clear icon element should be provided via the `clearElement` getter. */
|
|
1532
|
+
"clearButtonVisible"?: OrVaadinTextField['clearButtonVisible'];
|
|
1533
|
+
/** */
|
|
1534
|
+
"dir"?: OrVaadinTextField['dir'];
|
|
1535
|
+
/** Set when the element is disabled */
|
|
1536
|
+
"disabled"?: unknown;
|
|
1537
|
+
/** Set when the element is disabled */
|
|
1538
|
+
"undefined"?: unknown;
|
|
1539
|
+
/** Set when the element has a value */
|
|
1540
|
+
"has-value"?: unknown;
|
|
1541
|
+
/** Set when the element has a label */
|
|
1542
|
+
"has-label"?: unknown;
|
|
1543
|
+
/** Set when the element has helper text or slot */
|
|
1544
|
+
"has-helper"?: unknown;
|
|
1545
|
+
/** Set when the element has an error message */
|
|
1546
|
+
"has-error-message"?: unknown;
|
|
1547
|
+
/** Set when the element has a slotted tooltip */
|
|
1548
|
+
"has-tooltip"?: unknown;
|
|
1549
|
+
/** Set when the element is invalid */
|
|
1550
|
+
"invalid"?: unknown;
|
|
1551
|
+
/** Temporarily set when invalid input is prevented */
|
|
1552
|
+
"input-prevented"?: unknown;
|
|
1553
|
+
/** Set when the element is focused */
|
|
1554
|
+
"focused"?: unknown;
|
|
1555
|
+
/** Set when the element is keyboard focused */
|
|
1556
|
+
"focus-ring"?: unknown;
|
|
1557
|
+
/** */
|
|
1558
|
+
"_boundOnPaste"?: OrVaadinTextField['_boundOnPaste'];
|
|
1559
|
+
/** */
|
|
1560
|
+
"_boundOnDrop"?: OrVaadinTextField['_boundOnDrop'];
|
|
1561
|
+
/** */
|
|
1562
|
+
"_boundOnBeforeInput"?: OrVaadinTextField['_boundOnBeforeInput'];
|
|
1563
|
+
/** */
|
|
1564
|
+
"_fieldAriaController"?: OrVaadinTextField['_fieldAriaController'];
|
|
1565
|
+
/** */
|
|
1566
|
+
"_helperController"?: OrVaadinTextField['_helperController'];
|
|
1567
|
+
/** */
|
|
1568
|
+
"_errorController"?: OrVaadinTextField['_errorController'];
|
|
190
1569
|
|
|
191
1570
|
/** */
|
|
192
1571
|
"onsubmit"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1572
|
+
/** */
|
|
1573
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1574
|
+
/** Fired when the value is changed by the user: on every typing keystroke, and the value is cleared using the clear button. */
|
|
1575
|
+
"oninput"?: (e: CustomEvent<Event>) => void;
|
|
1576
|
+
/** Fired when the user commits a value change. */
|
|
1577
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
|
1578
|
+
/** Fired when the `invalid` property changes. */
|
|
1579
|
+
"oninvalid-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1580
|
+
/** Fired when the `value` property changes. */
|
|
1581
|
+
"onvalue-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1582
|
+
/** Fired whenever the field is validated. */
|
|
1583
|
+
"onvalidated"?: (e: CustomEvent<CustomEvent>) => void;
|
|
193
1584
|
}
|
|
194
1585
|
|
|
195
1586
|
|
|
196
1587
|
export type OrVaadinTimePickerProps = {
|
|
1588
|
+
/** The time value for this element.
|
|
1589
|
+
|
|
1590
|
+
Supported time formats are in ISO 8601:
|
|
1591
|
+
- `hh:mm` (default)
|
|
1592
|
+
- `hh:mm:ss`
|
|
1593
|
+
- `hh:mm:ss.fff` */
|
|
1594
|
+
"value"?: OrVaadinTimePicker['value'];
|
|
1595
|
+
/** Minimum time allowed.
|
|
1596
|
+
|
|
1597
|
+
Supported time formats are in ISO 8601:
|
|
1598
|
+
- `hh:mm`
|
|
1599
|
+
- `hh:mm:ss`
|
|
1600
|
+
- `hh:mm:ss.fff` */
|
|
1601
|
+
"min"?: OrVaadinTimePicker['min'];
|
|
1602
|
+
/** Maximum time allowed.
|
|
1603
|
+
|
|
1604
|
+
Supported time formats are in ISO 8601:
|
|
1605
|
+
- `hh:mm`
|
|
1606
|
+
- `hh:mm:ss`
|
|
1607
|
+
- `hh:mm:ss.fff` */
|
|
1608
|
+
"max"?: OrVaadinTimePicker['max'];
|
|
1609
|
+
/** Defines the time interval (in seconds) between the items displayed
|
|
1610
|
+
in the time selection box. The default is 1 hour (i.e. `3600`).
|
|
1611
|
+
|
|
1612
|
+
It also configures the precision of the value string. By default
|
|
1613
|
+
the component formats values as `hh:mm` but setting a step value
|
|
1614
|
+
lower than one minute or one second, format resolution changes to
|
|
1615
|
+
`hh:mm:ss` and `hh:mm:ss.fff` respectively.
|
|
1616
|
+
|
|
1617
|
+
Unit must be set in seconds, and for correctly configuring intervals
|
|
1618
|
+
in the dropdown, it need to evenly divide a day.
|
|
1619
|
+
|
|
1620
|
+
Note: it is possible to define step that is dividing an hour in inexact
|
|
1621
|
+
fragments (i.e. 5760 seconds which equals 1 hour 36 minutes), but it is
|
|
1622
|
+
not recommended to use it for better UX experience. */
|
|
1623
|
+
"step"?: OrVaadinTimePicker['step'];
|
|
1624
|
+
/** */
|
|
1625
|
+
"_comboBoxValue"?: OrVaadinTimePicker['_comboBoxValue'];
|
|
1626
|
+
/** */
|
|
1627
|
+
"_inputContainer"?: OrVaadinTimePicker['_inputContainer'];
|
|
1628
|
+
/** The object used to localize this component. To change the default
|
|
1629
|
+
localization, replace this with an object that provides all properties, or
|
|
1630
|
+
just the individual properties you want to change.
|
|
1631
|
+
|
|
1632
|
+
Should be overridden by subclasses to provide a custom JSDoc with the
|
|
1633
|
+
default I18N properties. */
|
|
1634
|
+
"i18n"?: OrVaadinTimePicker['i18n'];
|
|
1635
|
+
/** */
|
|
1636
|
+
"__effectiveI18n"?: OrVaadinTimePicker['__effectiveI18n'];
|
|
1637
|
+
/** */
|
|
1638
|
+
"dir"?: OrVaadinTimePicker['dir'];
|
|
1639
|
+
/** Set when the element is disabled */
|
|
1640
|
+
"disabled"?: unknown;
|
|
1641
|
+
/** Set when the element is disabled */
|
|
1642
|
+
"undefined"?: unknown;
|
|
1643
|
+
/** Set when the element has a value */
|
|
1644
|
+
"has-value"?: unknown;
|
|
1645
|
+
/** Set when the element has a label */
|
|
1646
|
+
"has-label"?: unknown;
|
|
1647
|
+
/** Set when the element has helper text or slot */
|
|
1648
|
+
"has-helper"?: unknown;
|
|
1649
|
+
/** Set when the element has an error message */
|
|
1650
|
+
"has-error-message"?: unknown;
|
|
1651
|
+
/** Set when the element has a slotted tooltip */
|
|
1652
|
+
"has-tooltip"?: unknown;
|
|
1653
|
+
/** Set when the element is invalid */
|
|
1654
|
+
"invalid"?: unknown;
|
|
1655
|
+
/** Set when the element is focused */
|
|
1656
|
+
"focused"?: unknown;
|
|
1657
|
+
/** Set when the element is keyboard focused */
|
|
1658
|
+
"focus-ring"?: unknown;
|
|
1659
|
+
/** Set when the element is readonly */
|
|
1660
|
+
"readonly"?: unknown;
|
|
1661
|
+
/** Set when the overlay is opened */
|
|
1662
|
+
"opened"?: unknown;
|
|
1663
|
+
/** */
|
|
1664
|
+
"<vaadin-time-picker>"?: unknown;
|
|
1665
|
+
/** */
|
|
1666
|
+
"<vaadin-time-picker-item>"?: unknown;
|
|
1667
|
+
/** */
|
|
1668
|
+
"<vaadin-item>"?: unknown;
|
|
1669
|
+
/** */
|
|
1670
|
+
"change"?: unknown;
|
|
1671
|
+
/** */
|
|
1672
|
+
"unparsable-change"?: unknown;
|
|
197
1673
|
|
|
198
|
-
|
|
1674
|
+
/** Fired when the user commits a value change. */
|
|
1675
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
|
1676
|
+
/** */
|
|
1677
|
+
"onunparsable-change"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1678
|
+
/** */
|
|
1679
|
+
"onundefined"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1680
|
+
/** Fired when the `invalid` property changes. */
|
|
1681
|
+
"oninvalid-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1682
|
+
/** Fired when the `opened` property changes. */
|
|
1683
|
+
"onopened-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1684
|
+
/** Fired when the `value` property changes. */
|
|
1685
|
+
"onvalue-changed"?: (e: CustomEvent<CustomEvent>) => void;
|
|
1686
|
+
/** Fired whenever the field is validated. */
|
|
1687
|
+
"onvalidated"?: (e: CustomEvent<CustomEvent>) => void;
|
|
199
1688
|
}
|
|
200
1689
|
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
|
|
201
1727
|
export type CustomElements = {
|
|
202
1728
|
|
|
203
1729
|
|
|
204
1730
|
/**
|
|
205
1731
|
*
|
|
1732
|
+
*
|
|
1733
|
+
* ## Attributes & Properties
|
|
1734
|
+
*
|
|
1735
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
1736
|
+
*
|
|
1737
|
+
* - `tabindex`: Indicates whether the element can be focused and where it participates in sequential keyboard navigation.
|
|
1738
|
+
* - `_lastTabIndex`: Stores the last known tabindex since the element has been disabled.
|
|
1739
|
+
* - `dir`: undefined
|
|
1740
|
+
* - `disabled`: When disabled, the button is rendered as "dimmed" and prevents all
|
|
1741
|
+
* user interactions (mouse and keyboard).
|
|
1742
|
+
*
|
|
1743
|
+
* Since disabled buttons are not focusable and cannot react to hover
|
|
1744
|
+
* events by default, it can cause accessibility issues by making them
|
|
1745
|
+
* entirely invisible to assistive technologies, and prevents the use
|
|
1746
|
+
* of Tooltips to explain why the action is not available. This can be
|
|
1747
|
+
* addressed by enabling the feature flag `accessibleDisabledButtons`,
|
|
1748
|
+
* which makes disabled buttons focusable and hoverable, while still
|
|
1749
|
+
* preventing them from being triggered:
|
|
1750
|
+
*
|
|
1751
|
+
* ```js
|
|
1752
|
+
* // Set before any button is attached to the DOM.
|
|
1753
|
+
* window.Vaadin.featureFlags.accessibleDisabledButtons = true
|
|
1754
|
+
* ```
|
|
1755
|
+
* - `active`/`undefined`: Set when the button is pressed down, either with mouse, touch or the keyboard
|
|
1756
|
+
* - `focus-ring`/`undefined`: Set when the button is focused using the keyboard
|
|
1757
|
+
* - `focused`/`undefined`: Set when the button is focused
|
|
1758
|
+
* - `has-tooltip`/`undefined`: Set when the button has a slotted tooltip
|
|
1759
|
+
*
|
|
1760
|
+
* ## Events
|
|
1761
|
+
*
|
|
1762
|
+
* Events that will be emitted by the component.
|
|
1763
|
+
*
|
|
1764
|
+
* - `undefined`: undefined
|
|
1765
|
+
*
|
|
1766
|
+
* ## Methods
|
|
1767
|
+
*
|
|
1768
|
+
* Methods that can be called to access component functionality.
|
|
1769
|
+
*
|
|
1770
|
+
* - `createProperty(name, options) => void`: undefined
|
|
1771
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
1772
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
1773
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
1774
|
+
*
|
|
1775
|
+
* ## CSS Custom Properties
|
|
1776
|
+
*
|
|
1777
|
+
* CSS variables available for styling the component.
|
|
1778
|
+
*
|
|
1779
|
+
* - `--vaadin-button-background`: undefined (default: `undefined`)
|
|
1780
|
+
* - `--vaadin-button-border-color`: undefined (default: `undefined`)
|
|
1781
|
+
* - `--vaadin-button-border-radius`: undefined (default: `undefined`)
|
|
1782
|
+
* - `--vaadin-button-border-width`: undefined (default: `undefined`)
|
|
1783
|
+
* - `--vaadin-button-font-size`: undefined (default: `undefined`)
|
|
1784
|
+
* - `--vaadin-button-font-weight`: undefined (default: `undefined`)
|
|
1785
|
+
* - `--vaadin-button-gap`: undefined (default: `undefined`)
|
|
1786
|
+
* - `--vaadin-button-height`: undefined (default: `undefined`)
|
|
1787
|
+
* - `--vaadin-button-line-height`: undefined (default: `undefined`)
|
|
1788
|
+
* - `--vaadin-button-margin`: undefined (default: `undefined`)
|
|
1789
|
+
* - `--vaadin-button-padding`: undefined (default: `undefined`)
|
|
1790
|
+
* - `--vaadin-button-text-color`: See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. (default: `undefined`)
|
|
206
1791
|
*/
|
|
207
1792
|
"or-vaadin-button": Partial<OrVaadinButtonProps & BaseProps<OrVaadinButton> & BaseEvents>;
|
|
208
1793
|
|
|
209
1794
|
|
|
210
1795
|
/**
|
|
211
1796
|
*
|
|
1797
|
+
*
|
|
1798
|
+
* ## Attributes & Properties
|
|
1799
|
+
*
|
|
1800
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
1801
|
+
*
|
|
1802
|
+
* - `value`: An array containing values of the currently checked checkboxes.
|
|
1803
|
+
*
|
|
1804
|
+
* The array is immutable so toggling checkboxes always results in
|
|
1805
|
+
* creating a new array.
|
|
1806
|
+
* - `readonly`: When true, the user cannot modify the value of the checkbox group.
|
|
1807
|
+
* The difference between `disabled` and `readonly` is that in the
|
|
1808
|
+
* read-only checkbox group, all the checkboxes are also read-only,
|
|
1809
|
+
* and therefore remain focusable and announced by screen readers.
|
|
1810
|
+
* - `ariaTarget`: A target element to which ARIA attributes are set.
|
|
1811
|
+
* - `errorMessage`: Error to show when the field is invalid.
|
|
1812
|
+
* - `helperText`: String used for the helper text.
|
|
1813
|
+
* - `accessibleName`: String used to label the component to screen reader users.
|
|
1814
|
+
* - `accessibleNameRef`: Id of the element used as label of the component to screen reader users.
|
|
1815
|
+
* - `dir`: undefined
|
|
1816
|
+
* - `disabled`/`undefined`: Set when the element is disabled
|
|
1817
|
+
* - `invalid`/`undefined`: Set when the element is invalid
|
|
1818
|
+
* - `focused`/`undefined`: Set when the element is focused
|
|
1819
|
+
* - `has-label`/`undefined`: Set when the element has a label
|
|
1820
|
+
* - `has-value`/`undefined`: Set when the element has a value
|
|
1821
|
+
* - `has-helper`/`undefined`: Set when the element has helper text
|
|
1822
|
+
* - `has-error-message`/`undefined`: Set when the element has an error message
|
|
1823
|
+
* - `has-tooltip`/`undefined`: Set when the element has a slotted tooltip
|
|
1824
|
+
* - `_tooltipController`: undefined (property only)
|
|
1825
|
+
* - `_fieldAriaController`: undefined (property only)
|
|
1826
|
+
* - `_helperController`: undefined (property only)
|
|
1827
|
+
* - `_errorController`: undefined (property only)
|
|
1828
|
+
*
|
|
1829
|
+
* ## Events
|
|
1830
|
+
*
|
|
1831
|
+
* Events that will be emitted by the component.
|
|
1832
|
+
*
|
|
1833
|
+
* - `undefined`: undefined
|
|
1834
|
+
* - `invalid-changed`: Fired when the `invalid` property changes.
|
|
1835
|
+
* - `value-changed`: Fired when the `value` property changes.
|
|
1836
|
+
* - `validated`: Fired whenever the field is validated.
|
|
1837
|
+
*
|
|
1838
|
+
* ## Methods
|
|
1839
|
+
*
|
|
1840
|
+
* Methods that can be called to access component functionality.
|
|
1841
|
+
*
|
|
1842
|
+
* - `checkValidity() => boolean`: Override method inherited from `ValidateMixin`
|
|
1843
|
+
* to validate the value array.
|
|
1844
|
+
* - `createProperty(name, options) => void`: undefined
|
|
1845
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
1846
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
1847
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
1848
|
+
*
|
|
1849
|
+
* ## CSS Custom Properties
|
|
1850
|
+
*
|
|
1851
|
+
* CSS variables available for styling the component.
|
|
1852
|
+
*
|
|
1853
|
+
* - `--vaadin-input-field-error-color`: undefined (default: `undefined`)
|
|
1854
|
+
* - `--vaadin-input-field-error-font-size`: undefined (default: `undefined`)
|
|
1855
|
+
* - `--vaadin-input-field-error-font-weight`: undefined (default: `undefined`)
|
|
1856
|
+
* - `--vaadin-input-field-error-line-height`: undefined (default: `undefined`)
|
|
1857
|
+
* - `--vaadin-input-field-label-color`: undefined (default: `undefined`)
|
|
1858
|
+
* - `--vaadin-input-field-label-font-size`: undefined (default: `undefined`)
|
|
1859
|
+
* - `--vaadin-input-field-label-font-weight`: undefined (default: `undefined`)
|
|
1860
|
+
* - `--vaadin-input-field-label-line-height`: undefined (default: `undefined`)
|
|
1861
|
+
* - `--vaadin-input-field-helper-color`: undefined (default: `undefined`)
|
|
1862
|
+
* - `--vaadin-input-field-helper-font-size`: undefined (default: `undefined`)
|
|
1863
|
+
* - `--vaadin-input-field-helper-font-weight`: undefined (default: `undefined`)
|
|
1864
|
+
* - `--vaadin-input-field-helper-line-height`: undefined (default: `undefined`)
|
|
1865
|
+
* - `--vaadin-input-field-required-indicator-color`: undefined (default: `undefined`)
|
|
1866
|
+
* - `--vaadin-input-field-required-indicator`: See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. (default: `undefined`)
|
|
212
1867
|
*/
|
|
213
1868
|
"or-vaadin-checkbox-group": Partial<OrVaadinCheckboxGroupProps & BaseProps<OrVaadinCheckboxGroup> & BaseEvents>;
|
|
214
1869
|
|
|
215
1870
|
|
|
216
1871
|
/**
|
|
217
1872
|
*
|
|
1873
|
+
*
|
|
1874
|
+
* ## Attributes & Properties
|
|
1875
|
+
*
|
|
1876
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
1877
|
+
*
|
|
1878
|
+
* - `indeterminate`: True if the checkbox is in the indeterminate state which means
|
|
1879
|
+
* it is not possible to say whether it is checked or unchecked.
|
|
1880
|
+
* The state is reset once the user switches the checkbox by hand.
|
|
1881
|
+
*
|
|
1882
|
+
* https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#Indeterminate_state_checkboxes
|
|
1883
|
+
* - `name`: The name of the checkbox.
|
|
1884
|
+
* - `readonly`: When true, the user cannot modify the value of the checkbox.
|
|
1885
|
+
* The difference between `disabled` and `readonly` is that the
|
|
1886
|
+
* read-only checkbox remains focusable, is announced by screen
|
|
1887
|
+
* readers and its value can be submitted as part of the form.
|
|
1888
|
+
* - `ariaTarget`: A target element to which ARIA attributes are set.
|
|
1889
|
+
* - `errorMessage`: Error to show when the field is invalid.
|
|
1890
|
+
* - `helperText`: String used for the helper text.
|
|
1891
|
+
* - `accessibleName`: String used to label the component to screen reader users.
|
|
1892
|
+
* - `accessibleNameRef`: Id of the element used as label of the component to screen reader users.
|
|
1893
|
+
* - `dir`: undefined
|
|
1894
|
+
* - `active`/`undefined`: Set when the checkbox is activated with mouse, touch or the keyboard.
|
|
1895
|
+
* - `checked`/`undefined`: Set when the checkbox is checked.
|
|
1896
|
+
* - `disabled`/`undefined`: Set when the checkbox is disabled.
|
|
1897
|
+
* - `focus-ring`/`undefined`: Set when the checkbox is focused using the keyboard.
|
|
1898
|
+
* - `focused`/`undefined`: Set when the checkbox is focused.
|
|
1899
|
+
* - `invalid`/`undefined`: Set when the checkbox is invalid.
|
|
1900
|
+
* - `has-label`/`undefined`: Set when the checkbox has a label.
|
|
1901
|
+
* - `has-helper`/`undefined`: Set when the checkbox has helper text.
|
|
1902
|
+
* - `has-error-message`/`undefined`: Set when the checkbox has an error message.
|
|
1903
|
+
* - `has-tooltip`/`undefined`: Set when the checkbox has a slotted tooltip.
|
|
1904
|
+
* - `_boundOnInputClick`: undefined (property only)
|
|
1905
|
+
* - `value`: undefined (property only)
|
|
1906
|
+
* - `tabindex`: undefined (property only)
|
|
1907
|
+
* - `_fieldAriaController`: undefined (property only)
|
|
1908
|
+
* - `_helperController`: undefined (property only)
|
|
1909
|
+
* - `_errorController`: undefined (property only)
|
|
1910
|
+
*
|
|
1911
|
+
* ## Events
|
|
1912
|
+
*
|
|
1913
|
+
* Events that will be emitted by the component.
|
|
1914
|
+
*
|
|
1915
|
+
* - `undefined`: undefined
|
|
1916
|
+
* - `change`: Fired when the checkbox is checked or unchecked by the user.
|
|
1917
|
+
* - `checked-changed`: Fired when the `checked` property changes.
|
|
1918
|
+
* - `indeterminate-changed`: Fired when the `indeterminate` property changes.
|
|
1919
|
+
*
|
|
1920
|
+
* ## Methods
|
|
1921
|
+
*
|
|
1922
|
+
* Methods that can be called to access component functionality.
|
|
1923
|
+
*
|
|
1924
|
+
* - `checkValidity() => boolean`: undefined
|
|
1925
|
+
* - `createProperty(name, options) => void`: undefined
|
|
1926
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
1927
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
1928
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
1929
|
+
*
|
|
1930
|
+
* ## CSS Custom Properties
|
|
1931
|
+
*
|
|
1932
|
+
* CSS variables available for styling the component.
|
|
1933
|
+
*
|
|
1934
|
+
* - `--vaadin-checkbox-background`: undefined (default: `undefined`)
|
|
1935
|
+
* - `--vaadin-checkbox-border-color`: undefined (default: `undefined`)
|
|
1936
|
+
* - `--vaadin-checkbox-border-radius`: undefined (default: `undefined`)
|
|
1937
|
+
* - `--vaadin-checkbox-border-width`: undefined (default: `undefined`)
|
|
1938
|
+
* - `--vaadin-checkbox-gap`: undefined (default: `undefined`)
|
|
1939
|
+
* - `--vaadin-checkbox-label-color`: undefined (default: `undefined`)
|
|
1940
|
+
* - `--vaadin-checkbox-label-font-size`: undefined (default: `undefined`)
|
|
1941
|
+
* - `--vaadin-checkbox-label-font-weight`: undefined (default: `undefined`)
|
|
1942
|
+
* - `--vaadin-checkbox-label-line-height`: undefined (default: `undefined`)
|
|
1943
|
+
* - `--vaadin-checkbox-marker-color`: undefined (default: `undefined`)
|
|
1944
|
+
* - `--vaadin-checkbox-marker-size`: undefined (default: `undefined`)
|
|
1945
|
+
* - `--vaadin-checkbox-size`: See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. (default: `undefined`)
|
|
218
1946
|
*/
|
|
219
1947
|
"or-vaadin-checkbox": Partial<OrVaadinCheckboxProps & BaseProps<OrVaadinCheckbox> & BaseEvents>;
|
|
220
1948
|
|
|
221
1949
|
|
|
222
1950
|
/**
|
|
223
1951
|
*
|
|
1952
|
+
*
|
|
1953
|
+
* ## Attributes & Properties
|
|
1954
|
+
*
|
|
1955
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
1956
|
+
*
|
|
1957
|
+
* - `_selectedDate`: The current selected date.
|
|
1958
|
+
* - `_focusedDate`: undefined
|
|
1959
|
+
* - `value`: Selected date.
|
|
1960
|
+
*
|
|
1961
|
+
* Supported date formats:
|
|
1962
|
+
* - ISO 8601 `"YYYY-MM-DD"` (default)
|
|
1963
|
+
* - 6-digit extended ISO 8601 `"+YYYYYY-MM-DD"`, `"-YYYYYY-MM-DD"`
|
|
1964
|
+
* - `initialPosition`: Date which should be visible when there is no value selected.
|
|
1965
|
+
*
|
|
1966
|
+
* The same date formats as for the `value` property are supported.
|
|
1967
|
+
* - `opened`: Set true to open the date selector overlay.
|
|
1968
|
+
* - `autoOpenDisabled`: Set true to prevent the overlay from opening automatically.
|
|
1969
|
+
* - `showWeekNumbers`: Set true to display ISO-8601 week numbers in the calendar. Notice that
|
|
1970
|
+
* displaying week numbers is only supported when `i18n.firstDayOfWeek`
|
|
1971
|
+
* is 1 (Monday).
|
|
1972
|
+
* - `_fullscreen`: undefined
|
|
1973
|
+
* - `_fullscreenMediaQuery`: undefined
|
|
1974
|
+
* - `min`: The earliest date that can be selected. All earlier dates will be disabled.
|
|
1975
|
+
*
|
|
1976
|
+
* Supported date formats:
|
|
1977
|
+
* - ISO 8601 `"YYYY-MM-DD"` (default)
|
|
1978
|
+
* - 6-digit extended ISO 8601 `"+YYYYYY-MM-DD"`, `"-YYYYYY-MM-DD"`
|
|
1979
|
+
* - `max`: The latest date that can be selected. All later dates will be disabled.
|
|
1980
|
+
*
|
|
1981
|
+
* Supported date formats:
|
|
1982
|
+
* - ISO 8601 `"YYYY-MM-DD"` (default)
|
|
1983
|
+
* - 6-digit extended ISO 8601 `"+YYYYYY-MM-DD"`, `"-YYYYYY-MM-DD"`
|
|
1984
|
+
* - `isDateDisabled`: A function to be used to determine whether the user can select a given date.
|
|
1985
|
+
* Receives a `DatePickerDate` object of the date to be selected and should return a
|
|
1986
|
+
* boolean.
|
|
1987
|
+
* - `_minDate`: The earliest date that can be selected. All earlier dates will be disabled.
|
|
1988
|
+
* - `_maxDate`: The latest date that can be selected. All later dates will be disabled.
|
|
1989
|
+
* - `_noInput`: undefined
|
|
1990
|
+
* - `_ios`: undefined
|
|
1991
|
+
* - `_focusOverlayOnOpen`: undefined
|
|
1992
|
+
* - `_overlayContent`: undefined
|
|
1993
|
+
* - `__enteredDate`: undefined
|
|
1994
|
+
* - `i18n`: The object used to localize this component. To change the default
|
|
1995
|
+
* localization, replace this with an object that provides all properties, or
|
|
1996
|
+
* just the individual properties you want to change.
|
|
1997
|
+
*
|
|
1998
|
+
* Should be overridden by subclasses to provide a custom JSDoc with the
|
|
1999
|
+
* default I18N properties.
|
|
2000
|
+
* - `__effectiveI18n`: undefined
|
|
2001
|
+
* - `allowedCharPattern`: A pattern matched against individual characters the user inputs.
|
|
2002
|
+
*
|
|
2003
|
+
* When set, the field will prevent:
|
|
2004
|
+
* - `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`
|
|
2005
|
+
* - `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`
|
|
2006
|
+
* - `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`
|
|
2007
|
+
*
|
|
2008
|
+
* For example, to allow entering only numbers and minus signs, use:
|
|
2009
|
+
* `allowedCharPattern = "[\\d-]"`
|
|
2010
|
+
* - `autoselect`: If true, the input text gets fully selected when the field is focused using click or touch / tap.
|
|
2011
|
+
* - `name`: The name of this field.
|
|
2012
|
+
* - `placeholder`: A hint to the user of what can be entered in the field.
|
|
2013
|
+
* - `readonly`: When present, it specifies that the field is read-only.
|
|
2014
|
+
* - `title`: The text usually displayed in a tooltip popup when the mouse is over the field.
|
|
2015
|
+
* - `ariaTarget`: A target element to which ARIA attributes are set.
|
|
2016
|
+
* - `errorMessage`: Error to show when the field is invalid.
|
|
2017
|
+
* - `helperText`: String used for the helper text.
|
|
2018
|
+
* - `accessibleName`: String used to label the component to screen reader users.
|
|
2019
|
+
* - `accessibleNameRef`: Id of the element used as label of the component to screen reader users.
|
|
2020
|
+
* - `clearButtonVisible`: Set to true to display the clear icon which clears the input.
|
|
2021
|
+
*
|
|
2022
|
+
* It is up to the component to choose where to place the clear icon:
|
|
2023
|
+
* in the Shadow DOM or in the light DOM. In any way, a reference to
|
|
2024
|
+
* the clear icon element should be provided via the `clearElement` getter.
|
|
2025
|
+
* - `dir`: undefined
|
|
2026
|
+
* - `_positionTarget`: undefined
|
|
2027
|
+
* - `disabled`/`undefined`: Set when the element is disabled
|
|
2028
|
+
* - `has-value`/`undefined`: Set when the element has a value
|
|
2029
|
+
* - `has-label`/`undefined`: Set when the element has a label
|
|
2030
|
+
* - `has-helper`/`undefined`: Set when the element has helper text or slot
|
|
2031
|
+
* - `has-error-message`/`undefined`: Set when the element has an error message
|
|
2032
|
+
* - `has-tooltip`/`undefined`: Set when the element has a slotted tooltip
|
|
2033
|
+
* - `invalid`/`undefined`: Set when the element is invalid
|
|
2034
|
+
* - `focused`/`undefined`: Set when the element is focused
|
|
2035
|
+
* - `focus-ring`/`undefined`: Set when the element is keyboard focused
|
|
2036
|
+
* - `week-numbers`/`undefined`: Set when week numbers are shown in the calendar
|
|
2037
|
+
* - `<vaadin-date-picker>`/`undefined`: undefined
|
|
2038
|
+
* - `<vaadin-date-picker-overlay-content>`/`undefined`: undefined
|
|
2039
|
+
* - `<vaadin-date-picker-month-scroller>`/`undefined`: undefined
|
|
2040
|
+
* - `<vaadin-date-picker-year-scroller>`/`undefined`: undefined
|
|
2041
|
+
* - `<vaadin-date-picker-year>`/`undefined`: undefined
|
|
2042
|
+
* - `<vaadin-month-calendar>`/`undefined`: undefined
|
|
2043
|
+
* - `years-toggle-button`/`undefined`: Fullscreen mode years scroller toggle
|
|
2044
|
+
* - `toolbar`/`undefined`: Toolbar with slotted buttons
|
|
2045
|
+
* - `_inputElementValue`: undefined (property only)
|
|
2046
|
+
* - `_boundOnClick`: undefined (property only)
|
|
2047
|
+
* - `_boundOnScroll`: undefined (property only)
|
|
2048
|
+
* - `_boundOnPaste`: undefined (property only)
|
|
2049
|
+
* - `_boundOnDrop`: undefined (property only)
|
|
2050
|
+
* - `_boundOnBeforeInput`: undefined (property only)
|
|
2051
|
+
* - `_fieldAriaController`: undefined (property only)
|
|
2052
|
+
* - `_helperController`: undefined (property only)
|
|
2053
|
+
* - `_errorController`: undefined (property only)
|
|
2054
|
+
*
|
|
2055
|
+
* ## Events
|
|
2056
|
+
*
|
|
2057
|
+
* Events that will be emitted by the component.
|
|
2058
|
+
*
|
|
2059
|
+
* - `change`: Fired when the user commits a value change.
|
|
2060
|
+
* - `unparsable-change`: Fired when the user commits an unparsable value change and there is no change event.
|
|
2061
|
+
* - `undefined`: undefined
|
|
2062
|
+
* - `invalid-changed`: Fired when the `invalid` property changes.
|
|
2063
|
+
* - `opened-changed`: Fired when the `opened` property changes.
|
|
2064
|
+
* - `value-changed`: Fired when the `value` property changes.
|
|
2065
|
+
* - `validated`: Fired whenever the field is validated.
|
|
2066
|
+
*
|
|
2067
|
+
* ## Methods
|
|
2068
|
+
*
|
|
2069
|
+
* Methods that can be called to access component functionality.
|
|
2070
|
+
*
|
|
2071
|
+
* - `open() => void`: Opens the dropdown.
|
|
2072
|
+
* - `close() => void`: Closes the dropdown.
|
|
2073
|
+
* - `checkValidity() => boolean`: Returns true if the current input value satisfies all constraints (if any)
|
|
2074
|
+
*
|
|
2075
|
+
* Override the `checkValidity` method for custom validations.
|
|
2076
|
+
* - `createProperty(name, options) => void`: undefined
|
|
2077
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
2078
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
2079
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
224
2080
|
*/
|
|
225
2081
|
"or-vaadin-date-picker": Partial<OrVaadinDatePickerProps & BaseProps<OrVaadinDatePicker> & BaseEvents>;
|
|
226
2082
|
|
|
227
2083
|
|
|
228
2084
|
/**
|
|
229
2085
|
*
|
|
2086
|
+
*
|
|
2087
|
+
* ## Attributes & Properties
|
|
2088
|
+
*
|
|
2089
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2090
|
+
*
|
|
2091
|
+
* - `name`: The name of the control, which is submitted with the form data.
|
|
2092
|
+
* - `value`: The value for this element.
|
|
2093
|
+
*
|
|
2094
|
+
* Supported date time format is based on ISO 8601 (without a time zone designator):
|
|
2095
|
+
* - Minute precision `"YYYY-MM-DDThh:mm"` (default)
|
|
2096
|
+
* - Second precision `"YYYY-MM-DDThh:mm:ss"`
|
|
2097
|
+
* - Millisecond precision `"YYYY-MM-DDThh:mm:ss.fff"`
|
|
2098
|
+
* - `min`: The earliest allowed value (date and time) that can be selected. All earlier values will be disabled.
|
|
2099
|
+
*
|
|
2100
|
+
* Supported date time format is based on ISO 8601 (without a time zone designator):
|
|
2101
|
+
* - Minute precision `"YYYY-MM-DDThh:mm"`
|
|
2102
|
+
* - Second precision `"YYYY-MM-DDThh:mm:ss"`
|
|
2103
|
+
* - Millisecond precision `"YYYY-MM-DDThh:mm:ss.fff"`
|
|
2104
|
+
* - `max`: The latest value (date and time) that can be selected. All later values will be disabled.
|
|
2105
|
+
*
|
|
2106
|
+
* Supported date time format is based on ISO 8601 (without a time zone designator):
|
|
2107
|
+
* - Minute precision `"YYYY-MM-DDThh:mm"`
|
|
2108
|
+
* - Second precision `"YYYY-MM-DDThh:mm:ss"`
|
|
2109
|
+
* - Millisecond precision `"YYYY-MM-DDThh:mm:ss.fff"`
|
|
2110
|
+
* - `__minDateTime`: The earliest value that can be selected. All earlier values will be disabled.
|
|
2111
|
+
* - `__maxDateTime`: The latest value that can be selected. All later values will be disabled.
|
|
2112
|
+
* - `datePlaceholder`: A placeholder string for the date field.
|
|
2113
|
+
* - `timePlaceholder`: A placeholder string for the time field.
|
|
2114
|
+
* - `step`: Defines the time interval (in seconds) between the items displayed
|
|
2115
|
+
* in the time selection box. The default is 1 hour (i.e. `3600`).
|
|
2116
|
+
*
|
|
2117
|
+
* It also configures the precision of the time part of the value string. By default
|
|
2118
|
+
* the component formats time values as `hh:mm` but setting a step value
|
|
2119
|
+
* lower than one minute or one second, format resolution changes to
|
|
2120
|
+
* `hh:mm:ss` and `hh:mm:ss.fff` respectively.
|
|
2121
|
+
*
|
|
2122
|
+
* Unit must be set in seconds, and for correctly configuring intervals
|
|
2123
|
+
* in the dropdown, it need to evenly divide a day.
|
|
2124
|
+
*
|
|
2125
|
+
* Note: it is possible to define step that is dividing an hour in inexact
|
|
2126
|
+
* fragments (i.e. 5760 seconds which equals 1 hour 36 minutes), but it is
|
|
2127
|
+
* not recommended to use it for better UX.
|
|
2128
|
+
* - `initialPosition`: Date which should be visible in the date picker overlay when there is no value selected.
|
|
2129
|
+
*
|
|
2130
|
+
* The same date formats as for the `value` property are supported but without the time part.
|
|
2131
|
+
* - `showWeekNumbers`: Set true to display ISO-8601 week numbers in the calendar. Notice that
|
|
2132
|
+
* displaying week numbers is only supported when `i18n.firstDayOfWeek`
|
|
2133
|
+
* is 1 (Monday).
|
|
2134
|
+
* - `autoOpenDisabled`: Set to true to prevent the overlays from opening automatically.
|
|
2135
|
+
* - `readonly`: Set to true to make this element read-only.
|
|
2136
|
+
* - `autofocus`: Specify that this control should have input focus when the page loads.
|
|
2137
|
+
* - `__selectedDateTime`: The current selected date time.
|
|
2138
|
+
* - `__datePicker`: The current slotted date picker.
|
|
2139
|
+
* - `__timePicker`: The current slotted time picker.
|
|
2140
|
+
* - `i18n`: The object used to localize this component. To change the default
|
|
2141
|
+
* localization, replace this with an object that provides all properties, or
|
|
2142
|
+
* just the individual properties you want to change.
|
|
2143
|
+
*
|
|
2144
|
+
* Should be overridden by subclasses to provide a custom JSDoc with the
|
|
2145
|
+
* default I18N properties.
|
|
2146
|
+
* - `__effectiveI18n`: undefined
|
|
2147
|
+
* - `dir`: undefined
|
|
2148
|
+
* - `disabled`/`undefined`: Set when the element is disabled
|
|
2149
|
+
* - `focused`/`undefined`: Set when the element is focused
|
|
2150
|
+
* - `focus-ring`/`undefined`: Set when the element is keyboard focused
|
|
2151
|
+
* - `invalid`/`undefined`: Set when the element is invalid
|
|
2152
|
+
* - `has-label`/`undefined`: Set when the element has a label
|
|
2153
|
+
* - `has-value`/`undefined`: Set when the element has a value
|
|
2154
|
+
* - `has-helper`/`undefined`: Set when the element has helper text
|
|
2155
|
+
* - `has-error-message`/`undefined`: Set when the element has an error message
|
|
2156
|
+
* - `has-tooltip`/`undefined`: Set when the element has a slotted tooltip
|
|
2157
|
+
* - `__defaultDateMinMaxValue`: undefined (property only)
|
|
2158
|
+
* - `__defaultTimeMinValue`: undefined (property only)
|
|
2159
|
+
* - `__defaultTimeMaxValue`: undefined (property only)
|
|
2160
|
+
*
|
|
2161
|
+
* ## Events
|
|
2162
|
+
*
|
|
2163
|
+
* Events that will be emitted by the component.
|
|
2164
|
+
*
|
|
2165
|
+
* - `change`: Fired when the user commits a value change.
|
|
2166
|
+
* - `unparsable-change`: Fired when the user commits an unparsable or incomplete value change and there is no change event.
|
|
2167
|
+
* - `undefined`: undefined
|
|
2168
|
+
* - `invalid-changed`: Fired when the `invalid` property changes.
|
|
2169
|
+
* - `value-changed`: Fired when the `value` property changes.
|
|
2170
|
+
* - `validated`: Fired whenever the field is validated.
|
|
2171
|
+
*
|
|
2172
|
+
* ## Methods
|
|
2173
|
+
*
|
|
2174
|
+
* Methods that can be called to access component functionality.
|
|
2175
|
+
*
|
|
2176
|
+
* - `checkValidity() => boolean`: Returns true if the current input value satisfies all constraints (if any)
|
|
2177
|
+
*
|
|
2178
|
+
* You can override the `checkValidity` method for custom validations.
|
|
2179
|
+
* - `createProperty(name, options) => void`: undefined
|
|
2180
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
2181
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
2182
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
2183
|
+
*
|
|
2184
|
+
* ## CSS Custom Properties
|
|
2185
|
+
*
|
|
2186
|
+
* CSS variables available for styling the component.
|
|
2187
|
+
*
|
|
2188
|
+
* - `--vaadin-date-time-picker-gap`: undefined (default: `undefined`)
|
|
2189
|
+
* - `--vaadin-input-field-error-color`: undefined (default: `undefined`)
|
|
2190
|
+
* - `--vaadin-input-field-error-font-size`: undefined (default: `undefined`)
|
|
2191
|
+
* - `--vaadin-input-field-error-font-weight`: undefined (default: `undefined`)
|
|
2192
|
+
* - `--vaadin-input-field-error-line-height`: undefined (default: `undefined`)
|
|
2193
|
+
* - `--vaadin-input-field-label-color`: undefined (default: `undefined`)
|
|
2194
|
+
* - `--vaadin-input-field-label-font-size`: undefined (default: `undefined`)
|
|
2195
|
+
* - `--vaadin-input-field-label-font-weight`: undefined (default: `undefined`)
|
|
2196
|
+
* - `--vaadin-input-field-label-line-height`: undefined (default: `undefined`)
|
|
2197
|
+
* - `--vaadin-input-field-helper-color`: undefined (default: `undefined`)
|
|
2198
|
+
* - `--vaadin-input-field-helper-font-size`: undefined (default: `undefined`)
|
|
2199
|
+
* - `--vaadin-input-field-helper-font-weight`: undefined (default: `undefined`)
|
|
2200
|
+
* - `--vaadin-input-field-helper-line-height`: undefined (default: `undefined`)
|
|
2201
|
+
* - `--vaadin-input-field-required-indicator-color`: undefined (default: `undefined`)
|
|
2202
|
+
* - `--vaadin-input-field-required-indicator`: ### Internal components (default: `undefined`)
|
|
2203
|
+
* - `<vaadin-date-time-picker>`: undefined (default: `undefined`)
|
|
2204
|
+
* - `<vaadin-date-picker>`: undefined (default: `undefined`)
|
|
2205
|
+
* - `<vaadin-time-picker>`: undefined (default: `undefined`)
|
|
2206
|
+
* - `change`: undefined (default: `undefined`)
|
|
2207
|
+
* - `unparsable-change`: undefined (default: `undefined`)
|
|
230
2208
|
*/
|
|
231
2209
|
"or-vaadin-date-time-picker": Partial<OrVaadinDateTimePickerProps & BaseProps<OrVaadinDateTimePicker> & BaseEvents>;
|
|
232
2210
|
|
|
@@ -234,18 +2212,194 @@ export type OrVaadinTimePickerProps = {
|
|
|
234
2212
|
/**
|
|
235
2213
|
*
|
|
236
2214
|
*
|
|
2215
|
+
* ## Attributes & Properties
|
|
2216
|
+
*
|
|
2217
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2218
|
+
*
|
|
2219
|
+
* - `width`: Set the width of the dialog.
|
|
2220
|
+
* If a unitless number is provided, pixels are assumed.
|
|
2221
|
+
* - `height`: Set the height of the dialog.
|
|
2222
|
+
* If a unitless number is provided, pixels are assumed.
|
|
2223
|
+
* - `draggable`: Set to true to enable repositioning the dialog by clicking and dragging.
|
|
2224
|
+
*
|
|
2225
|
+
* By default, only the overlay area can be used to drag the element. But,
|
|
2226
|
+
* a child element can be marked as a draggable area by adding a
|
|
2227
|
+
* "`draggable`" class to it, this will by default make all of its children draggable also.
|
|
2228
|
+
* If you want a child element to be draggable
|
|
2229
|
+
* but still have its children non-draggable (by default), mark it with
|
|
2230
|
+
* "`draggable-leaf-only`" class name.
|
|
2231
|
+
* - `_touchDevice`: undefined
|
|
2232
|
+
* - `__dragHandleClassName`: undefined
|
|
2233
|
+
* - `resizable`: Set to true to enable resizing the dialog by dragging the corners and edges.
|
|
2234
|
+
* - `renderer`: Custom function for rendering the content of the dialog.
|
|
2235
|
+
* Receives two arguments:
|
|
2236
|
+
*
|
|
2237
|
+
* - `root` The root container DOM element. Append your content to it.
|
|
2238
|
+
* - `dialog` The reference to the `<vaadin-dialog>` element.
|
|
2239
|
+
* - `headerTitle`: String used for rendering a dialog title.
|
|
2240
|
+
*
|
|
2241
|
+
* If both `headerTitle` and `headerRenderer` are defined, the title
|
|
2242
|
+
* and the elements created by the renderer will be placed next to
|
|
2243
|
+
* each other, with the title coming first.
|
|
2244
|
+
*
|
|
2245
|
+
* When `headerTitle` is set, the attribute `has-title` is set on the dialog.
|
|
2246
|
+
* - `headerRenderer`: Custom function for rendering the dialog header.
|
|
2247
|
+
* Receives two arguments:
|
|
2248
|
+
*
|
|
2249
|
+
* - `root` The root container DOM element. Append your content to it.
|
|
2250
|
+
* - `dialog` The reference to the `<vaadin-dialog>` element.
|
|
2251
|
+
*
|
|
2252
|
+
* If both `headerTitle` and `headerRenderer` are defined, the title
|
|
2253
|
+
* and the elements created by the renderer will be placed next to
|
|
2254
|
+
* each other, with the title coming first.
|
|
2255
|
+
*
|
|
2256
|
+
* When `headerRenderer` is set, the attribute `has-header` is set on the dialog.
|
|
2257
|
+
* - `footerRenderer`: Custom function for rendering the dialog footer.
|
|
2258
|
+
* Receives two arguments:
|
|
2259
|
+
*
|
|
2260
|
+
* - `root` The root container DOM element. Append your content to it.
|
|
2261
|
+
* - `dialog` The reference to the `<vaadin-dialog>` element.
|
|
2262
|
+
*
|
|
2263
|
+
* When `footerRenderer` is set, the attribute `has-footer` is set on the dialog.
|
|
2264
|
+
* - `opened`: True if the dialog is visible and available for interaction.
|
|
2265
|
+
* - `noCloseOnOutsideClick`: Set to true to disable closing dialog on outside click
|
|
2266
|
+
* - `noCloseOnEsc`: Set to true to disable closing dialog on Escape press
|
|
2267
|
+
* - `modeless`: Set to true to remove backdrop and allow click events on background elements.
|
|
2268
|
+
* - `top`: Set the distance of the dialog from the top of the viewport.
|
|
2269
|
+
* If a unitless number is provided, pixels are assumed.
|
|
2270
|
+
*
|
|
2271
|
+
* Note that the dialog uses an internal container that has some
|
|
2272
|
+
* additional spacing, which can be overridden by the theme.
|
|
2273
|
+
* - `left`: Set the distance of the dialog from the left of the viewport.
|
|
2274
|
+
* If a unitless number is provided, pixels are assumed.
|
|
2275
|
+
*
|
|
2276
|
+
* Note that the dialog uses an internal container that has some
|
|
2277
|
+
* additional spacing, which can be overridden by the theme.
|
|
2278
|
+
* - `overlayRole`: The `role` attribute value to be set on the dialog. Defaults to "dialog".
|
|
2279
|
+
* - `dir`: undefined
|
|
2280
|
+
* - `has-title`/`undefined`: Set when the element has a title
|
|
2281
|
+
* - `has-header`/`undefined`: Set when the element has header renderer
|
|
2282
|
+
* - `has-footer`/`undefined`: Set when the element has footer renderer
|
|
2283
|
+
* - `overflow`/`undefined`: Set to `top`, `bottom`, none or both
|
|
2284
|
+
*
|
|
2285
|
+
* ## Events
|
|
2286
|
+
*
|
|
2287
|
+
* Events that will be emitted by the component.
|
|
2288
|
+
*
|
|
2289
|
+
* - `dragged`: Fired when the dialog drag is finished.
|
|
2290
|
+
* - `resize`: Fired when the dialog resize is finished.
|
|
2291
|
+
* - `closed`: Fired when the dialog is closed.
|
|
2292
|
+
* - `undefined`: undefined
|
|
2293
|
+
* - `opened-changed`: Fired when the `opened` property changes.
|
|
2294
|
+
*
|
|
237
2295
|
* ## Methods
|
|
238
2296
|
*
|
|
239
2297
|
* Methods that can be called to access component functionality.
|
|
240
2298
|
*
|
|
241
|
-
* - `open() => void`: undefined
|
|
242
|
-
* - `close() => void`: undefined
|
|
2299
|
+
* - `open() => void`: undefined
|
|
2300
|
+
* - `close() => void`: undefined
|
|
2301
|
+
* - `requestContentUpdate() => void`: Requests an update for the content of the dialog.
|
|
2302
|
+
* While performing the update, it invokes the renderer passed in the `renderer` property,
|
|
2303
|
+
* as well as `headerRender` and `footerRenderer` properties, if these are defined.
|
|
2304
|
+
*
|
|
2305
|
+
* It is not guaranteed that the update happens immediately (synchronously) after it is requested.
|
|
2306
|
+
* - `createProperty(name, options) => void`: undefined
|
|
2307
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
2308
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
2309
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
2310
|
+
*
|
|
2311
|
+
* ## CSS Custom Properties
|
|
2312
|
+
*
|
|
2313
|
+
* CSS variables available for styling the component.
|
|
2314
|
+
*
|
|
2315
|
+
* - `--vaadin-dialog-background`: undefined (default: `undefined`)
|
|
2316
|
+
* - `--vaadin-dialog-border-color`: undefined (default: `undefined`)
|
|
2317
|
+
* - `--vaadin-dialog-border-radius`: undefined (default: `undefined`)
|
|
2318
|
+
* - `--vaadin-dialog-border-width`: undefined (default: `undefined`)
|
|
2319
|
+
* - `--vaadin-dialog-max-width`: undefined (default: `undefined`)
|
|
2320
|
+
* - `--vaadin-dialog-min-width`: undefined (default: `undefined`)
|
|
2321
|
+
* - `--vaadin-dialog-padding`: undefined (default: `undefined`)
|
|
2322
|
+
* - `--vaadin-dialog-shadow`: undefined (default: `undefined`)
|
|
2323
|
+
* - `--vaadin-dialog-title-color`: undefined (default: `undefined`)
|
|
2324
|
+
* - `--vaadin-dialog-title-font-size`: undefined (default: `undefined`)
|
|
2325
|
+
* - `--vaadin-dialog-title-font-weight`: undefined (default: `undefined`)
|
|
2326
|
+
* - `--vaadin-dialog-title-line-height`: undefined (default: `undefined`)
|
|
2327
|
+
* - `--vaadin-overlay-backdrop-background`: See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. (default: `undefined`)
|
|
243
2328
|
*/
|
|
244
2329
|
"or-vaadin-dialog": Partial<OrVaadinDialogProps & BaseProps<OrVaadinDialog> & BaseEvents>;
|
|
245
2330
|
|
|
246
2331
|
|
|
247
2332
|
/**
|
|
248
2333
|
*
|
|
2334
|
+
*
|
|
2335
|
+
* ## Attributes & Properties
|
|
2336
|
+
*
|
|
2337
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2338
|
+
*
|
|
2339
|
+
* - `class`/`undefined`: undefined
|
|
2340
|
+
* - `icon`: The name of the icon to use. The name should be of the form:
|
|
2341
|
+
* `iconset_name:icon_name`. When using `vaadin-icons` it is possible
|
|
2342
|
+
* to omit the first part and only use `icon_name` as a value.
|
|
2343
|
+
*
|
|
2344
|
+
* Setting the `icon` property updates the `svg` and `size` based on the
|
|
2345
|
+
* values provided by the corresponding `vaadin-iconset` element.
|
|
2346
|
+
*
|
|
2347
|
+
* See also [`name`](#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.
|
|
2348
|
+
* - `svg`: The SVG icon wrapped in a Lit template literal.
|
|
2349
|
+
* - `src`: The SVG source to be loaded as the icon. It can be:
|
|
2350
|
+
* - an URL to a file containing the icon
|
|
2351
|
+
* - an URL in the format `/path/to/file.svg#objectID`, where the `objectID` refers to an ID attribute contained
|
|
2352
|
+
* inside the SVG referenced by the path. Note that the file needs to follow the same-origin policy.
|
|
2353
|
+
* - a string in the format `data:image/svg+xml,<svg>...</svg>`. You may need to use the `encodeURIComponent`
|
|
2354
|
+
* function for the SVG content passed
|
|
2355
|
+
* - `symbol`: The symbol identifier that references an ID of an element contained in the SVG element assigned to the
|
|
2356
|
+
* `src` property
|
|
2357
|
+
* - `iconClass`: Class names defining an icon font and/or a specific glyph inside an icon font.
|
|
2358
|
+
*
|
|
2359
|
+
* Example: "fa-solid fa-user"
|
|
2360
|
+
* - `char`: A hexadecimal code point that specifies a glyph from an icon font.
|
|
2361
|
+
*
|
|
2362
|
+
* Example: "e001"
|
|
2363
|
+
* - `ligature`: A ligature name that specifies an icon from an icon font with support for ligatures.
|
|
2364
|
+
*
|
|
2365
|
+
* Example: "home".
|
|
2366
|
+
* - `fontFamily`: The font family to use for the font icon.
|
|
2367
|
+
* - `size`: The size of an icon, used to set the `viewBox` attribute.
|
|
2368
|
+
* - `__preserveAspectRatio`: undefined
|
|
2369
|
+
* - `__useRef`: undefined
|
|
2370
|
+
* - `__viewBox`: undefined
|
|
2371
|
+
* - `__fill`: undefined
|
|
2372
|
+
* - `__stroke`: undefined
|
|
2373
|
+
* - `__strokeWidth`: undefined
|
|
2374
|
+
* - `__strokeLinecap`: undefined
|
|
2375
|
+
* - `__strokeLinejoin`: undefined
|
|
2376
|
+
* - `dir`: undefined
|
|
2377
|
+
* - `has-tooltip`/`undefined`: Set when the icon has a slotted tooltip
|
|
2378
|
+
* - `__fetch`: undefined (property only)
|
|
2379
|
+
*
|
|
2380
|
+
* ## Events
|
|
2381
|
+
*
|
|
2382
|
+
* Events that will be emitted by the component.
|
|
2383
|
+
*
|
|
2384
|
+
* - `undefined`: undefined
|
|
2385
|
+
*
|
|
2386
|
+
* ## Methods
|
|
2387
|
+
*
|
|
2388
|
+
* Methods that can be called to access component functionality.
|
|
2389
|
+
*
|
|
2390
|
+
* - `createProperty(name, options) => void`: undefined
|
|
2391
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
2392
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
2393
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
2394
|
+
*
|
|
2395
|
+
* ## CSS Custom Properties
|
|
2396
|
+
*
|
|
2397
|
+
* CSS variables available for styling the component.
|
|
2398
|
+
*
|
|
2399
|
+
* - `--vaadin-icon-size`: Size (width and height) of the icon (default: `undefined`)
|
|
2400
|
+
* - `--vaadin-icon-stroke-width`: Stroke width of the SVG icon (default: `undefined`)
|
|
2401
|
+
* - `--vaadin-icon-visual-size`: Visual size of the icon (default: `undefined`)
|
|
2402
|
+
* - `has-tooltip`: Set when the icon has a slotted tooltip (default: `undefined`)
|
|
249
2403
|
*/
|
|
250
2404
|
"or-vaadin-icon": Partial<OrVaadinIconProps & BaseProps<OrVaadinIcon> & BaseEvents>;
|
|
251
2405
|
|
|
@@ -286,6 +2440,111 @@ export type OrVaadinTimePickerProps = {
|
|
|
286
2440
|
|
|
287
2441
|
/**
|
|
288
2442
|
*
|
|
2443
|
+
*
|
|
2444
|
+
* ## Attributes & Properties
|
|
2445
|
+
*
|
|
2446
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2447
|
+
*
|
|
2448
|
+
* - `autoExpandHorizontally`: Set to true to auto expand horizontally, causing input field to
|
|
2449
|
+
* grow until max width is reached.
|
|
2450
|
+
* - `autoExpandVertically`: Set to true to not collapse selected items chips into the overflow
|
|
2451
|
+
* chip and instead always expand vertically, causing input field to
|
|
2452
|
+
* wrap into multiple lines when width is limited.
|
|
2453
|
+
* - `itemClassNameGenerator`: A function used to generate CSS class names for dropdown
|
|
2454
|
+
* items and selected chips based on the item. The return
|
|
2455
|
+
* value should be the generated class name as a string, or
|
|
2456
|
+
* multiple class names separated by whitespace characters.
|
|
2457
|
+
* - `itemIdPath`: Path for the id of the item, used to detect whether the item is selected.
|
|
2458
|
+
* - `keepFilter`: When true, filter string isn't cleared after selecting an item.
|
|
2459
|
+
* - `loading`: True when loading items from the data provider, false otherwise.
|
|
2460
|
+
* - `readonly`: When present, it specifies that the field is read-only.
|
|
2461
|
+
* - `selectedItems`: The list of selected items.
|
|
2462
|
+
* Note: modifying the selected items creates a new array each time.
|
|
2463
|
+
* - `allowCustomValue`: When true, the user can input a value that is not present in the items list.
|
|
2464
|
+
* - `placeholder`: A hint to the user of what can be entered in the control.
|
|
2465
|
+
* The placeholder will be only displayed in the case when
|
|
2466
|
+
* there is no item selected.
|
|
2467
|
+
* - `renderer`: Custom function for rendering the content of every item.
|
|
2468
|
+
* Receives three arguments:
|
|
2469
|
+
*
|
|
2470
|
+
* - `root` The `<vaadin-multi-select-combo-box-item>` internal container DOM element.
|
|
2471
|
+
* - `comboBox` The reference to the `<vaadin-multi-select-combo-box>` element.
|
|
2472
|
+
* - `model` The object with the properties related with the rendered
|
|
2473
|
+
* item, contains:
|
|
2474
|
+
* - `model.index` The index of the rendered item.
|
|
2475
|
+
* - `model.item` The item.
|
|
2476
|
+
* - `selectedItemsOnTop`: Set to true to group selected items at the top of the overlay.
|
|
2477
|
+
* - `value`: undefined
|
|
2478
|
+
* - `_overflowItems`: undefined
|
|
2479
|
+
* - `_focusedChipIndex`: undefined
|
|
2480
|
+
* - `_lastFilter`: undefined
|
|
2481
|
+
* - `_topGroup`: undefined
|
|
2482
|
+
* - `_inputField`: undefined
|
|
2483
|
+
* - `i18n`: The object used to localize this component. To change the default
|
|
2484
|
+
* localization, replace this with an object that provides all properties, or
|
|
2485
|
+
* just the individual properties you want to change.
|
|
2486
|
+
*
|
|
2487
|
+
* Should be overridden by subclasses to provide a custom JSDoc with the
|
|
2488
|
+
* default I18N properties.
|
|
2489
|
+
* - `__effectiveI18n`: undefined
|
|
2490
|
+
* - `dir`: undefined
|
|
2491
|
+
* - `disabled`/`undefined`: Set to a disabled element
|
|
2492
|
+
* - `has-value`/`undefined`: Set when the element has a value
|
|
2493
|
+
* - `has-label`/`undefined`: Set when the element has a label
|
|
2494
|
+
* - `has-helper`/`undefined`: Set when the element has helper text or slot
|
|
2495
|
+
* - `has-error-message`/`undefined`: Set when the element has an error message
|
|
2496
|
+
* - `has-tooltip`/`undefined`: Set when the element has a slotted tooltip
|
|
2497
|
+
* - `invalid`/`undefined`: Set when the element is invalid
|
|
2498
|
+
* - `focused`/`undefined`: Set when the element is focused
|
|
2499
|
+
* - `focus-ring`/`undefined`: Set when the element is keyboard focused
|
|
2500
|
+
* - `opened`/`undefined`: Set when the dropdown is open
|
|
2501
|
+
*
|
|
2502
|
+
* ## Events
|
|
2503
|
+
*
|
|
2504
|
+
* Events that will be emitted by the component.
|
|
2505
|
+
*
|
|
2506
|
+
* - `custom-value-set`: Fired when the user sets a custom value.
|
|
2507
|
+
* - `change`: Fired when the user commits a value change.
|
|
2508
|
+
* - `undefined`: undefined
|
|
2509
|
+
* - `filter-changed`: Fired when the `filter` property changes.
|
|
2510
|
+
* - `invalid-changed`: Fired when the `invalid` property changes.
|
|
2511
|
+
* - `opened-changed`: Fired when the `opened` property changes.
|
|
2512
|
+
* - `selected-items-changed`: Fired when the `selectedItems` property changes.
|
|
2513
|
+
* - `validated`: Fired whenever the field is validated.
|
|
2514
|
+
*
|
|
2515
|
+
* ## Methods
|
|
2516
|
+
*
|
|
2517
|
+
* Methods that can be called to access component functionality.
|
|
2518
|
+
*
|
|
2519
|
+
* - `checkValidity() => boolean`: Returns true if the current input value satisfies all constraints (if any).
|
|
2520
|
+
* - `open() => void`: Opens the dropdown list.
|
|
2521
|
+
* - `clear() => void`: Clears the selected items.
|
|
2522
|
+
* - `clearCache() => void`: Clears the cached pages and reloads data from data provider when needed.
|
|
2523
|
+
* - `requestContentUpdate() => void`: Requests an update for the content of items.
|
|
2524
|
+
* While performing the update, it invokes the renderer (passed in the `renderer` property) once an item.
|
|
2525
|
+
*
|
|
2526
|
+
* It is not guaranteed that the update happens immediately (synchronously) after it is requested.
|
|
2527
|
+
* - `createProperty(name, options) => void`: undefined
|
|
2528
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
2529
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
2530
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
2531
|
+
*
|
|
2532
|
+
* ## CSS Custom Properties
|
|
2533
|
+
*
|
|
2534
|
+
* CSS variables available for styling the component.
|
|
2535
|
+
*
|
|
2536
|
+
* - `--vaadin-field-default-width`: Default width of the field (default: `undefined`)
|
|
2537
|
+
* - `12em`: undefined (default: `undefined`)
|
|
2538
|
+
* - `--vaadin-multi-select-combo-box-overlay-width`: Width of the overlay (default: `undefined`)
|
|
2539
|
+
* - `auto`: undefined (default: `undefined`)
|
|
2540
|
+
* - `--vaadin-multi-select-combo-box-overlay-max-height`: Max height of the overlay (default: `undefined`)
|
|
2541
|
+
* - `65vh`: undefined (default: `undefined`)
|
|
2542
|
+
* - `--vaadin-multi-select-combo-box-input-min-width`: Min width of the input (default: `undefined`)
|
|
2543
|
+
* - `4em`: undefined (default: `undefined`)
|
|
2544
|
+
* - `<vaadin-multi-select-combo-box>`: undefined (default: `undefined`)
|
|
2545
|
+
* - `<vaadin-multi-select-combo-box-chip>`: undefined (default: `undefined`)
|
|
2546
|
+
* - `<vaadin-multi-select-combo-box-item>`: undefined (default: `undefined`)
|
|
2547
|
+
* - `<vaadin-item>`: undefined (default: `undefined`)
|
|
289
2548
|
*/
|
|
290
2549
|
"or-vaadin-multi-select-combo-box": Partial<OrVaadinMultiSelectComboBoxProps & BaseProps<OrVaadinMultiSelectComboBox> & BaseEvents>;
|
|
291
2550
|
|
|
@@ -293,17 +2552,99 @@ export type OrVaadinTimePickerProps = {
|
|
|
293
2552
|
/**
|
|
294
2553
|
*
|
|
295
2554
|
*
|
|
2555
|
+
* ## Attributes & Properties
|
|
2556
|
+
*
|
|
2557
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2558
|
+
*
|
|
2559
|
+
* - `min`: The minimum value of the field.
|
|
2560
|
+
* - `max`: The maximum value of the field.
|
|
2561
|
+
* - `step`: Specifies the allowed number intervals of the field.
|
|
2562
|
+
* - `stepButtonsVisible`: Set to true to show increase/decrease buttons.
|
|
2563
|
+
* - `autocomplete`: Whether the value of the control can be automatically completed by the browser.
|
|
2564
|
+
* List of available options at:
|
|
2565
|
+
* https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete
|
|
2566
|
+
* - `autocorrect`: This is a property supported by Safari that is used to control whether
|
|
2567
|
+
* autocorrection should be enabled when the user is entering/editing the text.
|
|
2568
|
+
* Possible values are:
|
|
2569
|
+
* on: Enable autocorrection.
|
|
2570
|
+
* off: Disable autocorrection.
|
|
2571
|
+
* - `autocapitalize`: This is a property supported by Safari and Chrome that is used to control whether
|
|
2572
|
+
* autocapitalization should be enabled when the user is entering/editing the text.
|
|
2573
|
+
* Possible values are:
|
|
2574
|
+
* characters: Characters capitalization.
|
|
2575
|
+
* words: Words capitalization.
|
|
2576
|
+
* sentences: Sentences capitalization.
|
|
2577
|
+
* none: No capitalization.
|
|
2578
|
+
* - `allowedCharPattern`: A pattern matched against individual characters the user inputs.
|
|
2579
|
+
*
|
|
2580
|
+
* When set, the field will prevent:
|
|
2581
|
+
* - `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`
|
|
2582
|
+
* - `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`
|
|
2583
|
+
* - `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`
|
|
2584
|
+
*
|
|
2585
|
+
* For example, to allow entering only numbers and minus signs, use:
|
|
2586
|
+
* `allowedCharPattern = "[\\d-]"`
|
|
2587
|
+
* - `autoselect`: If true, the input text gets fully selected when the field is focused using click or touch / tap.
|
|
2588
|
+
* - `name`: The name of this field.
|
|
2589
|
+
* - `placeholder`: A hint to the user of what can be entered in the field.
|
|
2590
|
+
* - `readonly`: When present, it specifies that the field is read-only.
|
|
2591
|
+
* - `title`: The text usually displayed in a tooltip popup when the mouse is over the field.
|
|
2592
|
+
* - `ariaTarget`: A target element to which ARIA attributes are set.
|
|
2593
|
+
* - `errorMessage`: Error to show when the field is invalid.
|
|
2594
|
+
* - `helperText`: String used for the helper text.
|
|
2595
|
+
* - `accessibleName`: String used to label the component to screen reader users.
|
|
2596
|
+
* - `accessibleNameRef`: Id of the element used as label of the component to screen reader users.
|
|
2597
|
+
* - `clearButtonVisible`: Set to true to display the clear icon which clears the input.
|
|
2598
|
+
*
|
|
2599
|
+
* It is up to the component to choose where to place the clear icon:
|
|
2600
|
+
* in the Shadow DOM or in the light DOM. In any way, a reference to
|
|
2601
|
+
* the clear icon element should be provided via the `clearElement` getter.
|
|
2602
|
+
* - `dir`: undefined
|
|
2603
|
+
* - `disabled`/`undefined`: Set when the element is disabled
|
|
2604
|
+
* - `has-value`/`undefined`: Set when the element has a value
|
|
2605
|
+
* - `has-label`/`undefined`: Set when the element has a label
|
|
2606
|
+
* - `has-helper`/`undefined`: Set when the element has helper text or slot
|
|
2607
|
+
* - `has-error-message`/`undefined`: Set when the element has an error message
|
|
2608
|
+
* - `has-tooltip`/`undefined`: Set when the element has a slotted tooltip
|
|
2609
|
+
* - `invalid`/`undefined`: Set when the element is invalid
|
|
2610
|
+
* - `input-prevented`/`undefined`: Temporarily set when invalid input is prevented
|
|
2611
|
+
* - `focused`/`undefined`: Set when the element is focused
|
|
2612
|
+
* - `focus-ring`/`undefined`: Set when the element is keyboard focused
|
|
2613
|
+
* - `change`/`undefined`: undefined
|
|
2614
|
+
* - `unparsable-change`/`undefined`: undefined
|
|
2615
|
+
* - `_inputElementValue`: undefined (property only)
|
|
2616
|
+
* - `_boundOnPaste`: undefined (property only)
|
|
2617
|
+
* - `_boundOnDrop`: undefined (property only)
|
|
2618
|
+
* - `_boundOnBeforeInput`: undefined (property only)
|
|
2619
|
+
* - `_fieldAriaController`: undefined (property only)
|
|
2620
|
+
* - `_helperController`: undefined (property only)
|
|
2621
|
+
* - `_errorController`: undefined (property only)
|
|
2622
|
+
*
|
|
296
2623
|
* ## Events
|
|
297
2624
|
*
|
|
298
2625
|
* Events that will be emitted by the component.
|
|
299
2626
|
*
|
|
300
2627
|
* - `submit`: undefined
|
|
2628
|
+
* - `change`: Fired when the user commits a value change.
|
|
2629
|
+
* - `unparsable-change`: Fired when the user commits an unparsable value change and there is no change event.
|
|
2630
|
+
* - `undefined`: undefined
|
|
2631
|
+
* - `input`: Fired when the value is changed by the user: on every typing keystroke, and the value is cleared using the clear button.
|
|
2632
|
+
* - `invalid-changed`: Fired when the `invalid` property changes.
|
|
2633
|
+
* - `value-changed`: Fired when the `value` property changes.
|
|
2634
|
+
* - `validated`: Fired whenever the field is validated.
|
|
301
2635
|
*
|
|
302
2636
|
* ## Methods
|
|
303
2637
|
*
|
|
304
2638
|
* Methods that can be called to access component functionality.
|
|
305
2639
|
*
|
|
306
|
-
* - `
|
|
2640
|
+
* - `checkValidity() => void`: Override the method from `InputConstraintsMixin`
|
|
2641
|
+
* to enforce HTML constraint validation even if
|
|
2642
|
+
* the user didn't add any constraints explicitly:
|
|
2643
|
+
* the field has to be regardless checked for bad input.
|
|
2644
|
+
* - `createProperty(name, options) => void`: undefined
|
|
2645
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
2646
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
2647
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
307
2648
|
*/
|
|
308
2649
|
"or-vaadin-number-field": Partial<OrVaadinNumberFieldProps & BaseProps<OrVaadinNumberField> & BaseEvents>;
|
|
309
2650
|
|
|
@@ -311,29 +2652,281 @@ export type OrVaadinTimePickerProps = {
|
|
|
311
2652
|
/**
|
|
312
2653
|
*
|
|
313
2654
|
*
|
|
2655
|
+
* ## Attributes & Properties
|
|
2656
|
+
*
|
|
2657
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2658
|
+
*
|
|
2659
|
+
* - `revealButtonHidden`: Set to true to hide the eye icon which toggles the password visibility.
|
|
2660
|
+
* - `passwordVisible`: True if the password is visible ([type=text]).
|
|
2661
|
+
* - `i18n`: An object with translated strings used for localization.
|
|
2662
|
+
* It has the following structure and default values:
|
|
2663
|
+
*
|
|
2664
|
+
* ```js
|
|
2665
|
+
* {
|
|
2666
|
+
* // Translation of the reveal icon button accessible label
|
|
2667
|
+
* reveal: 'Show password'
|
|
2668
|
+
* }
|
|
2669
|
+
* ```
|
|
2670
|
+
* - `disabled`/`undefined`: Set when the element is disabled
|
|
2671
|
+
* - `has-value`/`undefined`: Set when the element has a value
|
|
2672
|
+
* - `has-label`/`undefined`: Set when the element has a label
|
|
2673
|
+
* - `has-helper`/`undefined`: Set when the element has helper text or slot
|
|
2674
|
+
* - `has-error-message`/`undefined`: Set when the element has an error message
|
|
2675
|
+
* - `has-tooltip`/`undefined`: Set when the element has a slotted tooltip
|
|
2676
|
+
* - `invalid`/`undefined`: Set when the element is invalid
|
|
2677
|
+
* - `input-prevented`/`undefined`: Temporarily set when invalid input is prevented
|
|
2678
|
+
* - `focused`/`undefined`: Set when the element is focused
|
|
2679
|
+
* - `focus-ring`/`undefined`: Set when the element is keyboard focused
|
|
2680
|
+
* - `readonly`: Set when the element is readonly
|
|
2681
|
+
* - `password-visible`/`undefined`: Set when the password is visible
|
|
2682
|
+
* - `allowedCharPattern`: undefined
|
|
2683
|
+
* - `maxlength`: Maximum number of characters (in Unicode code points) that the user can enter.
|
|
2684
|
+
* - `minlength`: Minimum number of characters (in Unicode code points) that the user can enter.
|
|
2685
|
+
* - `pattern`: A regular expression that the value is checked against.
|
|
2686
|
+
* The pattern must match the entire value, not just some subset.
|
|
2687
|
+
* - `autocomplete`: Whether the value of the control can be automatically completed by the browser.
|
|
2688
|
+
* List of available options at:
|
|
2689
|
+
* https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete
|
|
2690
|
+
* - `autocorrect`: This is a property supported by Safari that is used to control whether
|
|
2691
|
+
* autocorrection should be enabled when the user is entering/editing the text.
|
|
2692
|
+
* Possible values are:
|
|
2693
|
+
* on: Enable autocorrection.
|
|
2694
|
+
* off: Disable autocorrection.
|
|
2695
|
+
* - `autocapitalize`: This is a property supported by Safari and Chrome that is used to control whether
|
|
2696
|
+
* autocapitalization should be enabled when the user is entering/editing the text.
|
|
2697
|
+
* Possible values are:
|
|
2698
|
+
* characters: Characters capitalization.
|
|
2699
|
+
* words: Words capitalization.
|
|
2700
|
+
* sentences: Sentences capitalization.
|
|
2701
|
+
* none: No capitalization.
|
|
2702
|
+
* - `autoselect`: If true, the input text gets fully selected when the field is focused using click or touch / tap.
|
|
2703
|
+
* - `name`: The name of this field.
|
|
2704
|
+
* - `placeholder`: A hint to the user of what can be entered in the field.
|
|
2705
|
+
* - `title`: The text usually displayed in a tooltip popup when the mouse is over the field.
|
|
2706
|
+
* - `ariaTarget`: A target element to which ARIA attributes are set.
|
|
2707
|
+
* - `errorMessage`: Error to show when the field is invalid.
|
|
2708
|
+
* - `helperText`: String used for the helper text.
|
|
2709
|
+
* - `accessibleName`: String used to label the component to screen reader users.
|
|
2710
|
+
* - `accessibleNameRef`: Id of the element used as label of the component to screen reader users.
|
|
2711
|
+
* - `clearButtonVisible`: Set to true to display the clear icon which clears the input.
|
|
2712
|
+
*
|
|
2713
|
+
* It is up to the component to choose where to place the clear icon:
|
|
2714
|
+
* in the Shadow DOM or in the light DOM. In any way, a reference to
|
|
2715
|
+
* the clear icon element should be provided via the `clearElement` getter.
|
|
2716
|
+
* - `dir`: undefined
|
|
2717
|
+
* - `__boundRevealButtonClick`: undefined (property only)
|
|
2718
|
+
* - `__boundRevealButtonMouseDown`: undefined (property only)
|
|
2719
|
+
* - `__lastChange`: undefined (property only)
|
|
2720
|
+
* - `_boundOnPaste`: undefined (property only)
|
|
2721
|
+
* - `_boundOnDrop`: undefined (property only)
|
|
2722
|
+
* - `_boundOnBeforeInput`: undefined (property only)
|
|
2723
|
+
* - `_fieldAriaController`: undefined (property only)
|
|
2724
|
+
* - `_helperController`: undefined (property only)
|
|
2725
|
+
* - `_errorController`: undefined (property only)
|
|
2726
|
+
*
|
|
314
2727
|
* ## Events
|
|
315
2728
|
*
|
|
316
2729
|
* Events that will be emitted by the component.
|
|
317
2730
|
*
|
|
318
2731
|
* - `submit`: undefined
|
|
2732
|
+
* - `change`: Fired when the user commits a value change.
|
|
2733
|
+
* - `input`: Fired when the value is changed by the user: on every typing keystroke, and the value is cleared using the clear button.
|
|
2734
|
+
* - `invalid-changed`: Fired when the `invalid` property changes.
|
|
2735
|
+
* - `value-changed`: Fired when the `value` property changes.
|
|
2736
|
+
* - `validated`: Fired whenever the field is validated.
|
|
2737
|
+
* - `undefined`: undefined
|
|
319
2738
|
*
|
|
320
2739
|
* ## Methods
|
|
321
2740
|
*
|
|
322
2741
|
* Methods that can be called to access component functionality.
|
|
323
2742
|
*
|
|
324
2743
|
* - `_onEnter(ev: KeyboardEvent) => void`: undefined
|
|
2744
|
+
* - `createProperty(name, options) => void`: undefined
|
|
2745
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
2746
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
2747
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
325
2748
|
*/
|
|
326
2749
|
"or-vaadin-password-field": Partial<OrVaadinPasswordFieldProps & BaseProps<OrVaadinPasswordField> & BaseEvents>;
|
|
327
2750
|
|
|
328
2751
|
|
|
329
2752
|
/**
|
|
330
2753
|
*
|
|
2754
|
+
*
|
|
2755
|
+
* ## Attributes & Properties
|
|
2756
|
+
*
|
|
2757
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2758
|
+
*
|
|
2759
|
+
* - `name`: The name of the control, which is submitted with the form data.
|
|
2760
|
+
* - `value`: The value of the radio group.
|
|
2761
|
+
* - `readonly`: When present, the user cannot modify the value of the radio group.
|
|
2762
|
+
* The property works similarly to the `disabled` property.
|
|
2763
|
+
* While the `disabled` property disables all radio buttons inside the group,
|
|
2764
|
+
* the `readonly` property disables only unchecked ones.
|
|
2765
|
+
* - `_fieldName`: undefined
|
|
2766
|
+
* - `ariaTarget`: A target element to which ARIA attributes are set.
|
|
2767
|
+
* - `errorMessage`: Error to show when the field is invalid.
|
|
2768
|
+
* - `helperText`: String used for the helper text.
|
|
2769
|
+
* - `accessibleName`: String used to label the component to screen reader users.
|
|
2770
|
+
* - `accessibleNameRef`: Id of the element used as label of the component to screen reader users.
|
|
2771
|
+
* - `dir`: undefined
|
|
2772
|
+
* - `disabled`/`undefined`: Set when the element is disabled
|
|
2773
|
+
* - `invalid`/`undefined`: Set when the element is invalid
|
|
2774
|
+
* - `focused`/`undefined`: Set when the element is focused
|
|
2775
|
+
* - `has-label`/`undefined`: Set when the element has a label
|
|
2776
|
+
* - `has-value`/`undefined`: Set when the element has a value
|
|
2777
|
+
* - `has-helper`/`undefined`: Set when the element has helper text
|
|
2778
|
+
* - `has-error-message`/`undefined`: Set when the element has an error message
|
|
2779
|
+
* - `has-tooltip`/`undefined`: Set when the element has a slotted tooltip
|
|
2780
|
+
* - `_tooltipController`: undefined (property only)
|
|
2781
|
+
* - `_fieldAriaController`: undefined (property only)
|
|
2782
|
+
* - `_helperController`: undefined (property only)
|
|
2783
|
+
* - `_errorController`: undefined (property only)
|
|
2784
|
+
*
|
|
2785
|
+
* ## Events
|
|
2786
|
+
*
|
|
2787
|
+
* Events that will be emitted by the component.
|
|
2788
|
+
*
|
|
2789
|
+
* - `undefined`: undefined
|
|
2790
|
+
* - `invalid-changed`: Fired when the `invalid` property changes.
|
|
2791
|
+
* - `value-changed`: Fired when the `value` property changes.
|
|
2792
|
+
* - `validated`: Fired whenever the field is validated.
|
|
2793
|
+
*
|
|
2794
|
+
* ## Methods
|
|
2795
|
+
*
|
|
2796
|
+
* Methods that can be called to access component functionality.
|
|
2797
|
+
*
|
|
2798
|
+
* - `createProperty(name, options) => void`: undefined
|
|
2799
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
2800
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
2801
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
2802
|
+
*
|
|
2803
|
+
* ## CSS Custom Properties
|
|
2804
|
+
*
|
|
2805
|
+
* CSS variables available for styling the component.
|
|
2806
|
+
*
|
|
2807
|
+
* - `--vaadin-input-field-error-color`: undefined (default: `undefined`)
|
|
2808
|
+
* - `--vaadin-input-field-error-font-size`: undefined (default: `undefined`)
|
|
2809
|
+
* - `--vaadin-input-field-error-font-weight`: undefined (default: `undefined`)
|
|
2810
|
+
* - `--vaadin-input-field-error-line-height`: undefined (default: `undefined`)
|
|
2811
|
+
* - `--vaadin-input-field-label-color`: undefined (default: `undefined`)
|
|
2812
|
+
* - `--vaadin-input-field-label-font-size`: undefined (default: `undefined`)
|
|
2813
|
+
* - `--vaadin-input-field-label-font-weight`: undefined (default: `undefined`)
|
|
2814
|
+
* - `--vaadin-input-field-label-line-height`: undefined (default: `undefined`)
|
|
2815
|
+
* - `--vaadin-input-field-helper-color`: undefined (default: `undefined`)
|
|
2816
|
+
* - `--vaadin-input-field-helper-font-size`: undefined (default: `undefined`)
|
|
2817
|
+
* - `--vaadin-input-field-helper-font-weight`: undefined (default: `undefined`)
|
|
2818
|
+
* - `--vaadin-input-field-helper-line-height`: undefined (default: `undefined`)
|
|
2819
|
+
* - `--vaadin-input-field-required-indicator-color`: undefined (default: `undefined`)
|
|
2820
|
+
* - `--vaadin-input-field-required-indicator`: See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. (default: `undefined`)
|
|
331
2821
|
*/
|
|
332
2822
|
"or-vaadin-radio-group": Partial<OrVaadinRadioGroupProps & BaseProps<OrVaadinRadioGroup> & BaseEvents>;
|
|
333
2823
|
|
|
334
2824
|
|
|
335
2825
|
/**
|
|
336
2826
|
*
|
|
2827
|
+
*
|
|
2828
|
+
* ## Attributes & Properties
|
|
2829
|
+
*
|
|
2830
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2831
|
+
*
|
|
2832
|
+
* - `items`: An array containing items that will be rendered as the options of the select.
|
|
2833
|
+
*
|
|
2834
|
+
* #### Example
|
|
2835
|
+
* ```js
|
|
2836
|
+
* select.items = [
|
|
2837
|
+
* { label: 'Most recent first', value: 'recent' },
|
|
2838
|
+
* { component: 'hr' },
|
|
2839
|
+
* { label: 'Rating: low to high', value: 'rating-asc', className: 'asc' },
|
|
2840
|
+
* { label: 'Rating: high to low', value: 'rating-desc', className: 'desc' },
|
|
2841
|
+
* { component: 'hr' },
|
|
2842
|
+
* { label: 'Price: low to high', value: 'price-asc', disabled: true },
|
|
2843
|
+
* { label: 'Price: high to low', value: 'price-desc', disabled: true }
|
|
2844
|
+
* ];
|
|
2845
|
+
* ```
|
|
2846
|
+
*
|
|
2847
|
+
* Note: each item is rendered by default as the internal `<vaadin-select-item>` that is an extension of `<vaadin-item>`.
|
|
2848
|
+
* To render the item with a custom component, provide a tag name by the `component` property.
|
|
2849
|
+
* - `opened`: Set when the select is open
|
|
2850
|
+
* - `renderer`: Custom function for rendering the content of the `<vaadin-select>`.
|
|
2851
|
+
* Receives two arguments:
|
|
2852
|
+
*
|
|
2853
|
+
* - `root` The internal container DOM element. Append your content to it.
|
|
2854
|
+
* - `select` The reference to the `<vaadin-select>` element.
|
|
2855
|
+
* - `value`: The `value` property of the selected item, or an empty string
|
|
2856
|
+
* if no item is selected.
|
|
2857
|
+
* On change or initialization, the component finds the item which matches the
|
|
2858
|
+
* value and displays it.
|
|
2859
|
+
* If no value is provided to the component, it selects the first item without
|
|
2860
|
+
* value or empty value.
|
|
2861
|
+
* Hint: If you do not want to select any item by default, you can either set all
|
|
2862
|
+
* the values of inner vaadin-items, or set the vaadin-select value to
|
|
2863
|
+
* an inexistent value in the items list.
|
|
2864
|
+
* - `name`: The name of this element.
|
|
2865
|
+
* - `placeholder`: A hint to the user of what can be entered in the control.
|
|
2866
|
+
* The placeholder will be displayed in the case that there
|
|
2867
|
+
* is no item selected, or the selected item has an empty
|
|
2868
|
+
* string label, or the selected item has no label and it's
|
|
2869
|
+
* DOM content is empty.
|
|
2870
|
+
* - `readonly`: When present, it specifies that the element is read-only.
|
|
2871
|
+
* - `noVerticalOverlap`: Defines whether the overlay should overlap the target element
|
|
2872
|
+
* in the y-axis, or be positioned right above/below it.
|
|
2873
|
+
* - `_phone`: undefined
|
|
2874
|
+
* - `_phoneMediaQuery`: undefined
|
|
2875
|
+
* - `_inputContainer`: undefined
|
|
2876
|
+
* - `_items`: undefined
|
|
2877
|
+
* - `ariaTarget`: A target element to which ARIA attributes are set.
|
|
2878
|
+
* - `errorMessage`: Error to show when the field is invalid.
|
|
2879
|
+
* - `helperText`: String used for the helper text.
|
|
2880
|
+
* - `accessibleName`: String used to label the component to screen reader users.
|
|
2881
|
+
* - `accessibleNameRef`: Id of the element used as label of the component to screen reader users.
|
|
2882
|
+
* - `dir`: undefined
|
|
2883
|
+
* - `disabled`/`undefined`: Set when the element is disabled
|
|
2884
|
+
* - `has-value`/`undefined`: Set when the element has a value
|
|
2885
|
+
* - `has-label`/`undefined`: Set when the element has a label
|
|
2886
|
+
* - `has-helper`/`undefined`: Set when the element has helper text or slot
|
|
2887
|
+
* - `has-error-message`/`undefined`: Set when the element has an error message
|
|
2888
|
+
* - `invalid`/`undefined`: Set when the element is invalid
|
|
2889
|
+
* - `focused`/`undefined`: Set when the element is focused
|
|
2890
|
+
* - `focus-ring`/`undefined`: Set when the element is keyboard focused
|
|
2891
|
+
* - `phone`/`undefined`: Set when the overlay is shown in phone mode
|
|
2892
|
+
* - `<vaadin-select>`/`undefined`: undefined
|
|
2893
|
+
* - `<vaadin-select-value-button>`/`undefined`: undefined
|
|
2894
|
+
* - `<vaadin-button>`/`undefined`: undefined
|
|
2895
|
+
* - `<vaadin-select-list-box>`/`undefined`: undefined
|
|
2896
|
+
* - `<vaadin-list-box>`/`undefined`: undefined
|
|
2897
|
+
* - `<vaadin-select-item>`/`undefined`: undefined
|
|
2898
|
+
* - `<vaadin-item>`/`undefined`: undefined
|
|
2899
|
+
* - `_itemId`: undefined (property only)
|
|
2900
|
+
* - `_srLabelController`: undefined (property only)
|
|
2901
|
+
* - `slotName`: undefined (property only)
|
|
2902
|
+
* - `_fieldAriaController`: undefined (property only)
|
|
2903
|
+
* - `_helperController`: undefined (property only)
|
|
2904
|
+
* - `_errorController`: undefined (property only)
|
|
2905
|
+
*
|
|
2906
|
+
* ## Events
|
|
2907
|
+
*
|
|
2908
|
+
* Events that will be emitted by the component.
|
|
2909
|
+
*
|
|
2910
|
+
* - `change`: Fired when the user commits a value change.
|
|
2911
|
+
* - `undefined`: undefined
|
|
2912
|
+
* - `invalid-changed`: Fired when the `invalid` property changes.
|
|
2913
|
+
* - `opened-changed`: Fired when the `opened` property changes.
|
|
2914
|
+
* - `value-changed`: Fired when the `value` property changes.
|
|
2915
|
+
* - `validated`: Fired whenever the field is validated.
|
|
2916
|
+
*
|
|
2917
|
+
* ## Methods
|
|
2918
|
+
*
|
|
2919
|
+
* Methods that can be called to access component functionality.
|
|
2920
|
+
*
|
|
2921
|
+
* - `requestContentUpdate() => void`: Requests an update for the content of the select.
|
|
2922
|
+
* While performing the update, it invokes the renderer passed in the `renderer` property.
|
|
2923
|
+
*
|
|
2924
|
+
* It is not guaranteed that the update happens immediately (synchronously) after it is requested.
|
|
2925
|
+
* - `checkValidity() => boolean`: Returns true if the current value satisfies all constraints (if any)
|
|
2926
|
+
* - `createProperty(name, options) => void`: undefined
|
|
2927
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
2928
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
2929
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
337
2930
|
*/
|
|
338
2931
|
"or-vaadin-select": Partial<OrVaadinSelectProps & BaseProps<OrVaadinSelect> & BaseEvents>;
|
|
339
2932
|
|
|
@@ -341,17 +2934,101 @@ export type OrVaadinTimePickerProps = {
|
|
|
341
2934
|
/**
|
|
342
2935
|
*
|
|
343
2936
|
*
|
|
2937
|
+
* ## Attributes & Properties
|
|
2938
|
+
*
|
|
2939
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2940
|
+
*
|
|
2941
|
+
* - `maxlength`: Maximum number of characters (in Unicode code points) that the user can enter.
|
|
2942
|
+
* - `minlength`: Minimum number of characters (in Unicode code points) that the user can enter.
|
|
2943
|
+
* - `pattern`: A regular expression that the value is checked against.
|
|
2944
|
+
* The pattern must match the entire value, not just some subset.
|
|
2945
|
+
* - `minRows`: Minimum number of rows to show. Default is two rows.
|
|
2946
|
+
*
|
|
2947
|
+
* When using a custom slotted textarea, the minimum number of rows are not applied for backwards compatibility.
|
|
2948
|
+
* - `maxRows`: Maximum number of rows to expand to before the text area starts scrolling. This effectively sets a max-height
|
|
2949
|
+
* on the `input-field` part. By default, it is not set, and the text area grows with the content without
|
|
2950
|
+
* constraints.
|
|
2951
|
+
* - `autocomplete`: Whether the value of the control can be automatically completed by the browser.
|
|
2952
|
+
* List of available options at:
|
|
2953
|
+
* https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete
|
|
2954
|
+
* - `autocorrect`: This is a property supported by Safari that is used to control whether
|
|
2955
|
+
* autocorrection should be enabled when the user is entering/editing the text.
|
|
2956
|
+
* Possible values are:
|
|
2957
|
+
* on: Enable autocorrection.
|
|
2958
|
+
* off: Disable autocorrection.
|
|
2959
|
+
* - `autocapitalize`: This is a property supported by Safari and Chrome that is used to control whether
|
|
2960
|
+
* autocapitalization should be enabled when the user is entering/editing the text.
|
|
2961
|
+
* Possible values are:
|
|
2962
|
+
* characters: Characters capitalization.
|
|
2963
|
+
* words: Words capitalization.
|
|
2964
|
+
* sentences: Sentences capitalization.
|
|
2965
|
+
* none: No capitalization.
|
|
2966
|
+
* - `allowedCharPattern`: A pattern matched against individual characters the user inputs.
|
|
2967
|
+
*
|
|
2968
|
+
* When set, the field will prevent:
|
|
2969
|
+
* - `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`
|
|
2970
|
+
* - `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`
|
|
2971
|
+
* - `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`
|
|
2972
|
+
*
|
|
2973
|
+
* For example, to allow entering only numbers and minus signs, use:
|
|
2974
|
+
* `allowedCharPattern = "[\\d-]"`
|
|
2975
|
+
* - `autoselect`: If true, the input text gets fully selected when the field is focused using click or touch / tap.
|
|
2976
|
+
* - `name`: The name of this field.
|
|
2977
|
+
* - `placeholder`: A hint to the user of what can be entered in the field.
|
|
2978
|
+
* - `readonly`: When present, it specifies that the field is read-only.
|
|
2979
|
+
* - `title`: The text usually displayed in a tooltip popup when the mouse is over the field.
|
|
2980
|
+
* - `ariaTarget`: A target element to which ARIA attributes are set.
|
|
2981
|
+
* - `errorMessage`: Error to show when the field is invalid.
|
|
2982
|
+
* - `helperText`: String used for the helper text.
|
|
2983
|
+
* - `accessibleName`: String used to label the component to screen reader users.
|
|
2984
|
+
* - `accessibleNameRef`: Id of the element used as label of the component to screen reader users.
|
|
2985
|
+
* - `clearButtonVisible`: Set to true to display the clear icon which clears the input.
|
|
2986
|
+
*
|
|
2987
|
+
* It is up to the component to choose where to place the clear icon:
|
|
2988
|
+
* in the Shadow DOM or in the light DOM. In any way, a reference to
|
|
2989
|
+
* the clear icon element should be provided via the `clearElement` getter.
|
|
2990
|
+
* - `dir`: undefined
|
|
2991
|
+
* - `disabled`/`undefined`: Set when the element is disabled
|
|
2992
|
+
* - `has-value`/`undefined`: Set when the element has a value
|
|
2993
|
+
* - `has-label`/`undefined`: Set when the element has a label
|
|
2994
|
+
* - `has-helper`/`undefined`: Set when the element has helper text or slot
|
|
2995
|
+
* - `has-error-message`/`undefined`: Set when the element has an error message
|
|
2996
|
+
* - `has-tooltip`/`undefined`: Set when the element has a slotted tooltip
|
|
2997
|
+
* - `invalid`/`undefined`: Set when the element is invalid
|
|
2998
|
+
* - `input-prevented`/`undefined`: Temporarily set when invalid input is prevented
|
|
2999
|
+
* - `focused`/`undefined`: Set when the element is focused
|
|
3000
|
+
* - `focus-ring`/`undefined`: Set when the element is keyboard focused
|
|
3001
|
+
* - `_boundOnPaste`: undefined (property only)
|
|
3002
|
+
* - `_boundOnDrop`: undefined (property only)
|
|
3003
|
+
* - `_boundOnBeforeInput`: undefined (property only)
|
|
3004
|
+
* - `_fieldAriaController`: undefined (property only)
|
|
3005
|
+
* - `_helperController`: undefined (property only)
|
|
3006
|
+
* - `_errorController`: undefined (property only)
|
|
3007
|
+
*
|
|
344
3008
|
* ## Events
|
|
345
3009
|
*
|
|
346
3010
|
* Events that will be emitted by the component.
|
|
347
3011
|
*
|
|
348
3012
|
* - `submit`: undefined
|
|
3013
|
+
* - `undefined`: undefined
|
|
3014
|
+
* - `input`: Fired when the value is changed by the user: on every typing keystroke, and the value is cleared using the clear button.
|
|
3015
|
+
* - `change`: Fired when the user commits a value change.
|
|
3016
|
+
* - `invalid-changed`: Fired when the `invalid` property changes.
|
|
3017
|
+
* - `value-changed`: Fired when the `value` property changes.
|
|
3018
|
+
* - `validated`: Fired whenever the field is validated.
|
|
349
3019
|
*
|
|
350
3020
|
* ## Methods
|
|
351
3021
|
*
|
|
352
3022
|
* Methods that can be called to access component functionality.
|
|
353
3023
|
*
|
|
354
3024
|
* - `_onEnter(ev: KeyboardEvent) => void`: undefined
|
|
3025
|
+
* - `scrollToStart() => void`: Scrolls the textarea to the start if it has a vertical scrollbar.
|
|
3026
|
+
* - `scrollToEnd() => void`: Scrolls the textarea to the end if it has a vertical scrollbar.
|
|
3027
|
+
* - `checkValidity() => boolean`: Returns true if the current textarea value satisfies all constraints (if any).
|
|
3028
|
+
* - `createProperty(name, options) => void`: undefined
|
|
3029
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
3030
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
3031
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
355
3032
|
*/
|
|
356
3033
|
"or-vaadin-text-area": Partial<OrVaadinTextAreaProps & BaseProps<OrVaadinTextArea> & BaseEvents>;
|
|
357
3034
|
|
|
@@ -359,29 +3036,412 @@ export type OrVaadinTimePickerProps = {
|
|
|
359
3036
|
/**
|
|
360
3037
|
*
|
|
361
3038
|
*
|
|
3039
|
+
* ## Attributes & Properties
|
|
3040
|
+
*
|
|
3041
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3042
|
+
*
|
|
3043
|
+
* - `maxlength`: Maximum number of characters (in Unicode code points) that the user can enter.
|
|
3044
|
+
* - `minlength`: Minimum number of characters (in Unicode code points) that the user can enter.
|
|
3045
|
+
* - `pattern`: A regular expression that the value is checked against.
|
|
3046
|
+
* The pattern must match the entire value, not just some subset.
|
|
3047
|
+
* - `autocomplete`: Whether the value of the control can be automatically completed by the browser.
|
|
3048
|
+
* List of available options at:
|
|
3049
|
+
* https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete
|
|
3050
|
+
* - `autocorrect`: This is a property supported by Safari that is used to control whether
|
|
3051
|
+
* autocorrection should be enabled when the user is entering/editing the text.
|
|
3052
|
+
* Possible values are:
|
|
3053
|
+
* on: Enable autocorrection.
|
|
3054
|
+
* off: Disable autocorrection.
|
|
3055
|
+
* - `autocapitalize`: This is a property supported by Safari and Chrome that is used to control whether
|
|
3056
|
+
* autocapitalization should be enabled when the user is entering/editing the text.
|
|
3057
|
+
* Possible values are:
|
|
3058
|
+
* characters: Characters capitalization.
|
|
3059
|
+
* words: Words capitalization.
|
|
3060
|
+
* sentences: Sentences capitalization.
|
|
3061
|
+
* none: No capitalization.
|
|
3062
|
+
* - `allowedCharPattern`: A pattern matched against individual characters the user inputs.
|
|
3063
|
+
*
|
|
3064
|
+
* When set, the field will prevent:
|
|
3065
|
+
* - `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`
|
|
3066
|
+
* - `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`
|
|
3067
|
+
* - `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`
|
|
3068
|
+
*
|
|
3069
|
+
* For example, to allow entering only numbers and minus signs, use:
|
|
3070
|
+
* `allowedCharPattern = "[\\d-]"`
|
|
3071
|
+
* - `autoselect`: If true, the input text gets fully selected when the field is focused using click or touch / tap.
|
|
3072
|
+
* - `name`: The name of this field.
|
|
3073
|
+
* - `placeholder`: A hint to the user of what can be entered in the field.
|
|
3074
|
+
* - `readonly`: When present, it specifies that the field is read-only.
|
|
3075
|
+
* - `title`: The text usually displayed in a tooltip popup when the mouse is over the field.
|
|
3076
|
+
* - `ariaTarget`: A target element to which ARIA attributes are set.
|
|
3077
|
+
* - `errorMessage`: Error to show when the field is invalid.
|
|
3078
|
+
* - `helperText`: String used for the helper text.
|
|
3079
|
+
* - `accessibleName`: String used to label the component to screen reader users.
|
|
3080
|
+
* - `accessibleNameRef`: Id of the element used as label of the component to screen reader users.
|
|
3081
|
+
* - `clearButtonVisible`: Set to true to display the clear icon which clears the input.
|
|
3082
|
+
*
|
|
3083
|
+
* It is up to the component to choose where to place the clear icon:
|
|
3084
|
+
* in the Shadow DOM or in the light DOM. In any way, a reference to
|
|
3085
|
+
* the clear icon element should be provided via the `clearElement` getter.
|
|
3086
|
+
* - `dir`: undefined
|
|
3087
|
+
* - `disabled`/`undefined`: Set when the element is disabled
|
|
3088
|
+
* - `has-value`/`undefined`: Set when the element has a value
|
|
3089
|
+
* - `has-label`/`undefined`: Set when the element has a label
|
|
3090
|
+
* - `has-helper`/`undefined`: Set when the element has helper text or slot
|
|
3091
|
+
* - `has-error-message`/`undefined`: Set when the element has an error message
|
|
3092
|
+
* - `has-tooltip`/`undefined`: Set when the element has a slotted tooltip
|
|
3093
|
+
* - `invalid`/`undefined`: Set when the element is invalid
|
|
3094
|
+
* - `input-prevented`/`undefined`: Temporarily set when invalid input is prevented
|
|
3095
|
+
* - `focused`/`undefined`: Set when the element is focused
|
|
3096
|
+
* - `focus-ring`/`undefined`: Set when the element is keyboard focused
|
|
3097
|
+
* - `_boundOnPaste`: undefined (property only)
|
|
3098
|
+
* - `_boundOnDrop`: undefined (property only)
|
|
3099
|
+
* - `_boundOnBeforeInput`: undefined (property only)
|
|
3100
|
+
* - `_fieldAriaController`: undefined (property only)
|
|
3101
|
+
* - `_helperController`: undefined (property only)
|
|
3102
|
+
* - `_errorController`: undefined (property only)
|
|
3103
|
+
*
|
|
362
3104
|
* ## Events
|
|
363
3105
|
*
|
|
364
3106
|
* Events that will be emitted by the component.
|
|
365
3107
|
*
|
|
366
3108
|
* - `submit`: undefined
|
|
3109
|
+
* - `undefined`: undefined
|
|
3110
|
+
* - `input`: Fired when the value is changed by the user: on every typing keystroke, and the value is cleared using the clear button.
|
|
3111
|
+
* - `change`: Fired when the user commits a value change.
|
|
3112
|
+
* - `invalid-changed`: Fired when the `invalid` property changes.
|
|
3113
|
+
* - `value-changed`: Fired when the `value` property changes.
|
|
3114
|
+
* - `validated`: Fired whenever the field is validated.
|
|
367
3115
|
*
|
|
368
3116
|
* ## Methods
|
|
369
3117
|
*
|
|
370
3118
|
* Methods that can be called to access component functionality.
|
|
371
3119
|
*
|
|
372
3120
|
* - `_onEnter(ev: KeyboardEvent) => void`: undefined
|
|
3121
|
+
* - `createProperty(name, options) => void`: undefined
|
|
3122
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
3123
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
3124
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
373
3125
|
*/
|
|
374
3126
|
"or-vaadin-text-field": Partial<OrVaadinTextFieldProps & BaseProps<OrVaadinTextField> & BaseEvents>;
|
|
375
3127
|
|
|
376
3128
|
|
|
377
3129
|
/**
|
|
378
3130
|
*
|
|
3131
|
+
*
|
|
3132
|
+
* ## Attributes & Properties
|
|
3133
|
+
*
|
|
3134
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3135
|
+
*
|
|
3136
|
+
* - `value`: The time value for this element.
|
|
3137
|
+
*
|
|
3138
|
+
* Supported time formats are in ISO 8601:
|
|
3139
|
+
* - `hh:mm` (default)
|
|
3140
|
+
* - `hh:mm:ss`
|
|
3141
|
+
* - `hh:mm:ss.fff`
|
|
3142
|
+
* - `min`: Minimum time allowed.
|
|
3143
|
+
*
|
|
3144
|
+
* Supported time formats are in ISO 8601:
|
|
3145
|
+
* - `hh:mm`
|
|
3146
|
+
* - `hh:mm:ss`
|
|
3147
|
+
* - `hh:mm:ss.fff`
|
|
3148
|
+
* - `max`: Maximum time allowed.
|
|
3149
|
+
*
|
|
3150
|
+
* Supported time formats are in ISO 8601:
|
|
3151
|
+
* - `hh:mm`
|
|
3152
|
+
* - `hh:mm:ss`
|
|
3153
|
+
* - `hh:mm:ss.fff`
|
|
3154
|
+
* - `step`: Defines the time interval (in seconds) between the items displayed
|
|
3155
|
+
* in the time selection box. The default is 1 hour (i.e. `3600`).
|
|
3156
|
+
*
|
|
3157
|
+
* It also configures the precision of the value string. By default
|
|
3158
|
+
* the component formats values as `hh:mm` but setting a step value
|
|
3159
|
+
* lower than one minute or one second, format resolution changes to
|
|
3160
|
+
* `hh:mm:ss` and `hh:mm:ss.fff` respectively.
|
|
3161
|
+
*
|
|
3162
|
+
* Unit must be set in seconds, and for correctly configuring intervals
|
|
3163
|
+
* in the dropdown, it need to evenly divide a day.
|
|
3164
|
+
*
|
|
3165
|
+
* Note: it is possible to define step that is dividing an hour in inexact
|
|
3166
|
+
* fragments (i.e. 5760 seconds which equals 1 hour 36 minutes), but it is
|
|
3167
|
+
* not recommended to use it for better UX experience.
|
|
3168
|
+
* - `_comboBoxValue`: undefined
|
|
3169
|
+
* - `_inputContainer`: undefined
|
|
3170
|
+
* - `i18n`: The object used to localize this component. To change the default
|
|
3171
|
+
* localization, replace this with an object that provides all properties, or
|
|
3172
|
+
* just the individual properties you want to change.
|
|
3173
|
+
*
|
|
3174
|
+
* Should be overridden by subclasses to provide a custom JSDoc with the
|
|
3175
|
+
* default I18N properties.
|
|
3176
|
+
* - `__effectiveI18n`: undefined
|
|
3177
|
+
* - `dir`: undefined
|
|
3178
|
+
* - `disabled`/`undefined`: Set when the element is disabled
|
|
3179
|
+
* - `has-value`/`undefined`: Set when the element has a value
|
|
3180
|
+
* - `has-label`/`undefined`: Set when the element has a label
|
|
3181
|
+
* - `has-helper`/`undefined`: Set when the element has helper text or slot
|
|
3182
|
+
* - `has-error-message`/`undefined`: Set when the element has an error message
|
|
3183
|
+
* - `has-tooltip`/`undefined`: Set when the element has a slotted tooltip
|
|
3184
|
+
* - `invalid`/`undefined`: Set when the element is invalid
|
|
3185
|
+
* - `focused`/`undefined`: Set when the element is focused
|
|
3186
|
+
* - `focus-ring`/`undefined`: Set when the element is keyboard focused
|
|
3187
|
+
* - `readonly`/`undefined`: Set when the element is readonly
|
|
3188
|
+
* - `opened`/`undefined`: Set when the overlay is opened
|
|
3189
|
+
* - `<vaadin-time-picker>`/`undefined`: undefined
|
|
3190
|
+
* - `<vaadin-time-picker-item>`/`undefined`: undefined
|
|
3191
|
+
* - `<vaadin-item>`/`undefined`: undefined
|
|
3192
|
+
* - `change`/`undefined`: undefined
|
|
3193
|
+
* - `unparsable-change`/`undefined`: undefined
|
|
3194
|
+
*
|
|
3195
|
+
* ## Events
|
|
3196
|
+
*
|
|
3197
|
+
* Events that will be emitted by the component.
|
|
3198
|
+
*
|
|
3199
|
+
* - `change`: Fired when the user commits a value change.
|
|
3200
|
+
* - `unparsable-change`: undefined
|
|
3201
|
+
* - `undefined`: undefined
|
|
3202
|
+
* - `invalid-changed`: Fired when the `invalid` property changes.
|
|
3203
|
+
* - `opened-changed`: Fired when the `opened` property changes.
|
|
3204
|
+
* - `value-changed`: Fired when the `value` property changes.
|
|
3205
|
+
* - `validated`: Fired whenever the field is validated.
|
|
3206
|
+
*
|
|
3207
|
+
* ## Methods
|
|
3208
|
+
*
|
|
3209
|
+
* Methods that can be called to access component functionality.
|
|
3210
|
+
*
|
|
3211
|
+
* - `checkValidity() => boolean`: Returns true if the current input value satisfies all constraints (if any).
|
|
3212
|
+
* You can override this method for custom validations.
|
|
3213
|
+
* - `createProperty(name, options) => void`: undefined
|
|
3214
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
3215
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
3216
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
379
3217
|
*/
|
|
380
3218
|
"or-vaadin-time-picker": Partial<OrVaadinTimePickerProps & BaseProps<OrVaadinTimePicker> & BaseEvents>;
|
|
3219
|
+
|
|
3220
|
+
|
|
3221
|
+
|
|
3222
|
+
|
|
3223
|
+
|
|
3224
|
+
|
|
3225
|
+
|
|
3226
|
+
|
|
3227
|
+
|
|
3228
|
+
|
|
3229
|
+
|
|
3230
|
+
|
|
3231
|
+
|
|
3232
|
+
|
|
3233
|
+
|
|
3234
|
+
|
|
3235
|
+
|
|
3236
|
+
|
|
3237
|
+
|
|
3238
|
+
|
|
3239
|
+
|
|
3240
|
+
|
|
3241
|
+
|
|
3242
|
+
|
|
3243
|
+
|
|
3244
|
+
|
|
3245
|
+
|
|
3246
|
+
|
|
3247
|
+
|
|
3248
|
+
|
|
3249
|
+
|
|
3250
|
+
|
|
3251
|
+
|
|
3252
|
+
|
|
3253
|
+
|
|
3254
|
+
|
|
3255
|
+
|
|
381
3256
|
}
|
|
382
3257
|
|
|
383
3258
|
export type CustomCssProperties = {
|
|
384
|
-
|
|
3259
|
+
/** */
|
|
3260
|
+
"--vaadin-button-background"?: string;
|
|
3261
|
+
/** */
|
|
3262
|
+
"--vaadin-button-border-color"?: string;
|
|
3263
|
+
/** */
|
|
3264
|
+
"--vaadin-button-border-radius"?: string;
|
|
3265
|
+
/** */
|
|
3266
|
+
"--vaadin-button-border-width"?: string;
|
|
3267
|
+
/** */
|
|
3268
|
+
"--vaadin-button-font-size"?: string;
|
|
3269
|
+
/** */
|
|
3270
|
+
"--vaadin-button-font-weight"?: string;
|
|
3271
|
+
/** */
|
|
3272
|
+
"--vaadin-button-gap"?: string;
|
|
3273
|
+
/** */
|
|
3274
|
+
"--vaadin-button-height"?: string;
|
|
3275
|
+
/** */
|
|
3276
|
+
"--vaadin-button-line-height"?: string;
|
|
3277
|
+
/** */
|
|
3278
|
+
"--vaadin-button-margin"?: string;
|
|
3279
|
+
/** */
|
|
3280
|
+
"--vaadin-button-padding"?: string;
|
|
3281
|
+
/** See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. */
|
|
3282
|
+
"--vaadin-button-text-color"?: string;
|
|
3283
|
+
/** */
|
|
3284
|
+
"--vaadin-input-field-error-color"?: string;
|
|
3285
|
+
/** */
|
|
3286
|
+
"--vaadin-input-field-error-font-size"?: string;
|
|
3287
|
+
/** */
|
|
3288
|
+
"--vaadin-input-field-error-font-weight"?: string;
|
|
3289
|
+
/** */
|
|
3290
|
+
"--vaadin-input-field-error-line-height"?: string;
|
|
3291
|
+
/** */
|
|
3292
|
+
"--vaadin-input-field-label-color"?: string;
|
|
3293
|
+
/** */
|
|
3294
|
+
"--vaadin-input-field-label-font-size"?: string;
|
|
3295
|
+
/** */
|
|
3296
|
+
"--vaadin-input-field-label-font-weight"?: string;
|
|
3297
|
+
/** */
|
|
3298
|
+
"--vaadin-input-field-label-line-height"?: string;
|
|
3299
|
+
/** */
|
|
3300
|
+
"--vaadin-input-field-helper-color"?: string;
|
|
3301
|
+
/** */
|
|
3302
|
+
"--vaadin-input-field-helper-font-size"?: string;
|
|
3303
|
+
/** */
|
|
3304
|
+
"--vaadin-input-field-helper-font-weight"?: string;
|
|
3305
|
+
/** */
|
|
3306
|
+
"--vaadin-input-field-helper-line-height"?: string;
|
|
3307
|
+
/** */
|
|
3308
|
+
"--vaadin-input-field-required-indicator-color"?: string;
|
|
3309
|
+
/** See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. */
|
|
3310
|
+
"--vaadin-input-field-required-indicator"?: string;
|
|
3311
|
+
/** */
|
|
3312
|
+
"--vaadin-checkbox-background"?: string;
|
|
3313
|
+
/** */
|
|
3314
|
+
"--vaadin-checkbox-border-color"?: string;
|
|
3315
|
+
/** */
|
|
3316
|
+
"--vaadin-checkbox-border-radius"?: string;
|
|
3317
|
+
/** */
|
|
3318
|
+
"--vaadin-checkbox-border-width"?: string;
|
|
3319
|
+
/** */
|
|
3320
|
+
"--vaadin-checkbox-gap"?: string;
|
|
3321
|
+
/** */
|
|
3322
|
+
"--vaadin-checkbox-label-color"?: string;
|
|
3323
|
+
/** */
|
|
3324
|
+
"--vaadin-checkbox-label-font-size"?: string;
|
|
3325
|
+
/** */
|
|
3326
|
+
"--vaadin-checkbox-label-font-weight"?: string;
|
|
3327
|
+
/** */
|
|
3328
|
+
"--vaadin-checkbox-label-line-height"?: string;
|
|
3329
|
+
/** */
|
|
3330
|
+
"--vaadin-checkbox-marker-color"?: string;
|
|
3331
|
+
/** */
|
|
3332
|
+
"--vaadin-checkbox-marker-size"?: string;
|
|
3333
|
+
/** See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. */
|
|
3334
|
+
"--vaadin-checkbox-size"?: string;
|
|
3335
|
+
/** */
|
|
3336
|
+
"--vaadin-date-time-picker-gap"?: string;
|
|
3337
|
+
/** */
|
|
3338
|
+
"<vaadin-date-time-picker>"?: string;
|
|
3339
|
+
/** */
|
|
3340
|
+
"<vaadin-date-picker>"?: string;
|
|
3341
|
+
/** */
|
|
3342
|
+
"<vaadin-time-picker>"?: string;
|
|
3343
|
+
/** */
|
|
3344
|
+
"change"?: string;
|
|
3345
|
+
/** */
|
|
3346
|
+
"unparsable-change"?: string;
|
|
3347
|
+
/** */
|
|
3348
|
+
"--vaadin-dialog-background"?: string;
|
|
3349
|
+
/** */
|
|
3350
|
+
"--vaadin-dialog-border-color"?: string;
|
|
3351
|
+
/** */
|
|
3352
|
+
"--vaadin-dialog-border-radius"?: string;
|
|
3353
|
+
/** */
|
|
3354
|
+
"--vaadin-dialog-border-width"?: string;
|
|
3355
|
+
/** */
|
|
3356
|
+
"--vaadin-dialog-max-width"?: string;
|
|
3357
|
+
/** */
|
|
3358
|
+
"--vaadin-dialog-min-width"?: string;
|
|
3359
|
+
/** */
|
|
3360
|
+
"--vaadin-dialog-padding"?: string;
|
|
3361
|
+
/** */
|
|
3362
|
+
"--vaadin-dialog-shadow"?: string;
|
|
3363
|
+
/** */
|
|
3364
|
+
"--vaadin-dialog-title-color"?: string;
|
|
3365
|
+
/** */
|
|
3366
|
+
"--vaadin-dialog-title-font-size"?: string;
|
|
3367
|
+
/** */
|
|
3368
|
+
"--vaadin-dialog-title-font-weight"?: string;
|
|
3369
|
+
/** */
|
|
3370
|
+
"--vaadin-dialog-title-line-height"?: string;
|
|
3371
|
+
/** See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. */
|
|
3372
|
+
"--vaadin-overlay-backdrop-background"?: string;
|
|
3373
|
+
/** Size (width and height) of the icon */
|
|
3374
|
+
"--vaadin-icon-size"?: string;
|
|
3375
|
+
/** Stroke width of the SVG icon */
|
|
3376
|
+
"--vaadin-icon-stroke-width"?: string;
|
|
3377
|
+
/** Visual size of the icon */
|
|
3378
|
+
"--vaadin-icon-visual-size"?: string;
|
|
3379
|
+
/** Set when the icon has a slotted tooltip */
|
|
3380
|
+
"has-tooltip"?: string;
|
|
3381
|
+
/** Default width of the field */
|
|
3382
|
+
"--vaadin-field-default-width"?: string;
|
|
3383
|
+
/** */
|
|
3384
|
+
"12em"?: string;
|
|
3385
|
+
/** Width of the overlay */
|
|
3386
|
+
"--vaadin-multi-select-combo-box-overlay-width"?: string;
|
|
3387
|
+
/** */
|
|
3388
|
+
"auto"?: string;
|
|
3389
|
+
/** Max height of the overlay */
|
|
3390
|
+
"--vaadin-multi-select-combo-box-overlay-max-height"?: string;
|
|
3391
|
+
/** */
|
|
3392
|
+
"65vh"?: string;
|
|
3393
|
+
/** Min width of the input */
|
|
3394
|
+
"--vaadin-multi-select-combo-box-input-min-width"?: string;
|
|
3395
|
+
/** */
|
|
3396
|
+
"4em"?: string;
|
|
3397
|
+
/** */
|
|
3398
|
+
"<vaadin-multi-select-combo-box>"?: string;
|
|
3399
|
+
/** */
|
|
3400
|
+
"<vaadin-multi-select-combo-box-chip>"?: string;
|
|
3401
|
+
/** */
|
|
3402
|
+
"<vaadin-multi-select-combo-box-item>"?: string;
|
|
3403
|
+
/** */
|
|
3404
|
+
"<vaadin-item>"?: string;
|
|
3405
|
+
/** */
|
|
3406
|
+
"--vaadin-item-border-radius"?: string;
|
|
3407
|
+
/** */
|
|
3408
|
+
"--vaadin-item-checkmark-color"?: string;
|
|
3409
|
+
/** */
|
|
3410
|
+
"--vaadin-item-checkmark-display"?: string;
|
|
3411
|
+
/** */
|
|
3412
|
+
"--vaadin-item-gap"?: string;
|
|
3413
|
+
/** */
|
|
3414
|
+
"--vaadin-item-height"?: string;
|
|
3415
|
+
/** */
|
|
3416
|
+
"--vaadin-item-padding"?: string;
|
|
3417
|
+
/** See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. */
|
|
3418
|
+
"--vaadin-item-text-align"?: string;
|
|
3419
|
+
/** */
|
|
3420
|
+
"--vaadin-radio-button-background"?: string;
|
|
3421
|
+
/** */
|
|
3422
|
+
"--vaadin-radio-button-border-color"?: string;
|
|
3423
|
+
/** */
|
|
3424
|
+
"--vaadin-radio-button-border-width"?: string;
|
|
3425
|
+
/** */
|
|
3426
|
+
"--vaadin-radio-button-gap"?: string;
|
|
3427
|
+
/** */
|
|
3428
|
+
"--vaadin-radio-button-label-color"?: string;
|
|
3429
|
+
/** */
|
|
3430
|
+
"--vaadin-radio-button-label-font-size"?: string;
|
|
3431
|
+
/** */
|
|
3432
|
+
"--vaadin-radio-button-label-font-weight"?: string;
|
|
3433
|
+
/** */
|
|
3434
|
+
"--vaadin-radio-button-label-line-height"?: string;
|
|
3435
|
+
/** */
|
|
3436
|
+
"--vaadin-radio-button-marker-color"?: string;
|
|
3437
|
+
/** */
|
|
3438
|
+
"--vaadin-radio-button-marker-size"?: string;
|
|
3439
|
+
/** See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. */
|
|
3440
|
+
"--vaadin-radio-button-size"?: string;
|
|
3441
|
+
/** Bottom offset of the visible viewport area */
|
|
3442
|
+
"--vaadin-overlay-viewport-bottom"?: string;
|
|
3443
|
+
/** */
|
|
3444
|
+
"0"?: string;
|
|
385
3445
|
}
|
|
386
3446
|
|
|
387
3447
|
|