@riverty/web-components 5.7.0 → 5.8.0
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/CHANGELOG.md +42 -0
- package/custom-elements.json +28 -3
- package/dist/cjs/loader.cjs.js +1 -1
- package/dist/cjs/r-alert.cjs.entry.js +24 -8
- package/dist/cjs/r-button.cjs.entry.js +1 -1
- package/dist/cjs/r-checkbox-group.cjs.entry.js +27 -13
- package/dist/cjs/r-checkbox.cjs.entry.js +25 -10
- package/dist/cjs/r-icon-button.cjs.entry.js +1 -1
- package/dist/cjs/r-icon.cjs.entry.js +1 -1
- package/dist/cjs/r-input-code.cjs.entry.js +29 -16
- package/dist/cjs/r-input-date.cjs.entry.js +85 -15
- package/dist/cjs/r-input-password.cjs.entry.js +20 -7
- package/dist/cjs/r-input-phone-number.cjs.entry.js +27 -14
- package/dist/cjs/r-input.cjs.entry.js +24 -11
- package/dist/cjs/r-pagination.cjs.entry.js +1 -1
- package/dist/cjs/r-popover-action.cjs.entry.js +1 -1
- package/dist/cjs/r-popover.cjs.entry.js +1 -1
- package/dist/cjs/r-radio-group.cjs.entry.js +20 -16
- package/dist/cjs/r-select.cjs.entry.js +112 -18
- package/dist/cjs/r-textarea.cjs.entry.js +18 -5
- package/dist/cjs/r-toast.cjs.entry.js +50 -19
- package/dist/cjs/web-components.cjs.js +1 -1
- package/dist/collection/components/alert/alert.css +52 -12
- package/dist/collection/components/alert/alert.js +48 -11
- package/dist/collection/components/alert/exports.js +1 -1
- package/dist/collection/components/button/button.css +6 -7
- package/dist/collection/components/checkbox/checkbox.js +45 -10
- package/dist/collection/components/checkbox-group/checkbox-group.js +47 -13
- package/dist/collection/components/icon/bundled-icons/riverty-kit.json +1 -1
- package/dist/collection/components/icon/riverty-kit.js +1 -1
- package/dist/collection/components/icon-button/icon-button.css +0 -7
- package/dist/collection/components/input/input.js +44 -11
- package/dist/collection/components/input-code/input-code.js +49 -16
- package/dist/collection/components/input-date/input-date.js +235 -16
- package/dist/collection/components/input-password/input-password.js +40 -7
- package/dist/collection/components/input-phone-number/input-phone-number.js +47 -14
- package/dist/collection/components/pagination/pagination.css +23 -23
- package/dist/collection/components/popover/popover.css +11 -3
- package/dist/collection/components/popover-action/popover-action.css +3 -5
- package/dist/collection/components/radio-group/radio-group.js +21 -17
- package/dist/collection/components/select/select.js +193 -21
- package/dist/collection/components/textarea/textarea.js +38 -5
- package/dist/collection/components/toast/toast.css +22 -14
- package/dist/collection/components/toast/toast.js +94 -20
- package/dist/esm/loader.js +1 -1
- package/dist/esm/r-alert.entry.js +24 -8
- package/dist/esm/r-button.entry.js +1 -1
- package/dist/esm/r-checkbox-group.entry.js +27 -13
- package/dist/esm/r-checkbox.entry.js +25 -10
- package/dist/esm/r-icon-button.entry.js +1 -1
- package/dist/esm/r-icon.entry.js +1 -1
- package/dist/esm/r-input-code.entry.js +29 -16
- package/dist/esm/r-input-date.entry.js +85 -15
- package/dist/esm/r-input-password.entry.js +20 -7
- package/dist/esm/r-input-phone-number.entry.js +27 -14
- package/dist/esm/r-input.entry.js +24 -11
- package/dist/esm/r-pagination.entry.js +1 -1
- package/dist/esm/r-popover-action.entry.js +1 -1
- package/dist/esm/r-popover.entry.js +1 -1
- package/dist/esm/r-radio-group.entry.js +20 -16
- package/dist/esm/r-select.entry.js +112 -18
- package/dist/esm/r-textarea.entry.js +18 -5
- package/dist/esm/r-toast.entry.js +50 -19
- package/dist/esm/web-components.js +1 -1
- package/dist/types/components/alert/alert.d.ts +3 -0
- package/dist/types/components/alert/exports.d.ts +1 -1
- package/dist/types/components/checkbox/checkbox.d.ts +5 -0
- package/dist/types/components/checkbox-group/checkbox-group.d.ts +6 -0
- package/dist/types/components/input/input.d.ts +5 -0
- package/dist/types/components/input-code/input-code.d.ts +5 -0
- package/dist/types/components/input-date/input-date.d.ts +30 -0
- package/dist/types/components/input-password/input-password.d.ts +5 -0
- package/dist/types/components/input-phone-number/input-phone-number.d.ts +5 -0
- package/dist/types/components/radio-group/radio-group.d.ts +1 -2
- package/dist/types/components/select/select.d.ts +34 -2
- package/dist/types/components/textarea/textarea.d.ts +5 -0
- package/dist/types/components/toast/toast.d.ts +10 -2
- package/dist/types/components.d.ts +143 -8
- package/dist/web-components/bundled-icons/riverty-kit.json +1 -1
- package/dist/web-components/p-15ac0fdd.entry.js +1 -0
- package/dist/web-components/p-1c956370.entry.js +1 -0
- package/dist/web-components/p-2a512983.entry.js +1 -0
- package/dist/web-components/p-2e18e762.entry.js +1 -0
- package/dist/web-components/{p-72c0c0d8.entry.js → p-3078b2b8.entry.js} +1 -1
- package/dist/web-components/p-56da04d8.entry.js +1 -0
- package/dist/web-components/p-5744d75c.entry.js +1 -0
- package/dist/web-components/p-5bbd6e3c.entry.js +1 -0
- package/dist/web-components/p-5e6aabd8.entry.js +1 -0
- package/dist/web-components/p-656229de.entry.js +1 -0
- package/dist/web-components/p-6a4f3836.entry.js +1 -0
- package/dist/web-components/p-7775228c.entry.js +1 -0
- package/dist/web-components/p-8563a1ab.entry.js +1 -0
- package/dist/web-components/p-ad9b2a48.entry.js +1 -0
- package/dist/web-components/p-b87ad83b.entry.js +1 -0
- package/dist/web-components/{p-77155630.entry.js → p-b98ab649.entry.js} +1 -1
- package/dist/web-components/p-dbe579e8.entry.js +1 -0
- package/dist/web-components/p-f2577a3c.entry.js +1 -0
- package/dist/web-components/web-components.esm.js +1 -1
- package/package.json +1 -1
- package/dist/web-components/p-289eb4b0.entry.js +0 -1
- package/dist/web-components/p-2b8e12ae.entry.js +0 -1
- package/dist/web-components/p-2e2c8a5b.entry.js +0 -1
- package/dist/web-components/p-3a39932b.entry.js +0 -1
- package/dist/web-components/p-44be9992.entry.js +0 -1
- package/dist/web-components/p-4652635a.entry.js +0 -1
- package/dist/web-components/p-63474b32.entry.js +0 -1
- package/dist/web-components/p-74d2a563.entry.js +0 -1
- package/dist/web-components/p-8028c2a9.entry.js +0 -1
- package/dist/web-components/p-96ddeb7f.entry.js +0 -1
- package/dist/web-components/p-9d898089.entry.js +0 -1
- package/dist/web-components/p-9eb1f262.entry.js +0 -1
- package/dist/web-components/p-c300c22f.entry.js +0 -1
- package/dist/web-components/p-d93c240d.entry.js +0 -1
- package/dist/web-components/p-f770e22b.entry.js +0 -1
- package/dist/web-components/p-f952161b.entry.js +0 -1
|
@@ -131,6 +131,11 @@ export declare class Checkbox {
|
|
|
131
131
|
* Sets the indeterminate state of the checkbox element.
|
|
132
132
|
*/
|
|
133
133
|
clearIndeterminate(): Promise<void>;
|
|
134
|
+
/**
|
|
135
|
+
* Validates the checkbox without triggering UI and returns a boolean indicating its validity.
|
|
136
|
+
* @returns A boolean indicating whether the checkbox is valid.
|
|
137
|
+
*/
|
|
138
|
+
checkValidity(): Promise<boolean>;
|
|
134
139
|
private get hasErrorMessage();
|
|
135
140
|
private get hasCustomErrorMessage();
|
|
136
141
|
private get hasValidationError();
|
|
@@ -90,6 +90,11 @@ export declare class CheckboxGroup {
|
|
|
90
90
|
validityMessage: string;
|
|
91
91
|
private uniqueId;
|
|
92
92
|
private initial;
|
|
93
|
+
/**
|
|
94
|
+
* Validates the checkbox group without triggering UI and returns a boolean indicating its validity.
|
|
95
|
+
* @returns A boolean indicating whether the checkbox is valid.
|
|
96
|
+
*/
|
|
97
|
+
checkValidity(): Promise<boolean>;
|
|
93
98
|
/**
|
|
94
99
|
* Resets the validity state and message of the radio group.
|
|
95
100
|
* This method clears the validity message and state, and sets the invalid
|
|
@@ -114,6 +119,7 @@ export declare class CheckboxGroup {
|
|
|
114
119
|
private updateCheckboxesState;
|
|
115
120
|
private get message();
|
|
116
121
|
private renderMessage;
|
|
122
|
+
private getValidityStateData;
|
|
117
123
|
private validateGroup;
|
|
118
124
|
private get parentFormEl();
|
|
119
125
|
private get isNoValidate();
|
|
@@ -266,6 +266,11 @@ export declare class RInput {
|
|
|
266
266
|
* Set the current value programmatically (does not fire native input/change automatically).
|
|
267
267
|
*/
|
|
268
268
|
setValue(value: string): Promise<void>;
|
|
269
|
+
/**
|
|
270
|
+
* Validates the input without triggering UI and returns a boolean indicating its validity.
|
|
271
|
+
* @returns A boolean indicating whether the input is valid.
|
|
272
|
+
*/
|
|
273
|
+
checkValidity(): Promise<boolean>;
|
|
269
274
|
private nativeElement;
|
|
270
275
|
private uniqueId;
|
|
271
276
|
/**
|
|
@@ -78,6 +78,11 @@ export declare class InputCode {
|
|
|
78
78
|
* Sets provided value.
|
|
79
79
|
* */
|
|
80
80
|
setValue(value: any): Promise<void>;
|
|
81
|
+
/**
|
|
82
|
+
* Validates the input code without triggering UI and returns a boolean indicating its validity.
|
|
83
|
+
* @returns A boolean indicating whether the input code is valid.
|
|
84
|
+
*/
|
|
85
|
+
checkValidity(): Promise<boolean>;
|
|
81
86
|
handleValuesChange(): void;
|
|
82
87
|
private handleInput;
|
|
83
88
|
private handleKeyDown;
|
|
@@ -64,6 +64,20 @@ export declare class InputDate {
|
|
|
64
64
|
valueMissingMessage?: string;
|
|
65
65
|
/** Custom error message displayed when date is not valid. */
|
|
66
66
|
invalidDateMessage?: string;
|
|
67
|
+
/**
|
|
68
|
+
* Minimum date value (in the same format as the date input).
|
|
69
|
+
* Note: When changing the `format` prop, ensure `min` is also updated to match the new format.
|
|
70
|
+
*/
|
|
71
|
+
min?: string;
|
|
72
|
+
/**
|
|
73
|
+
* Maximum date value (in the same format as the date input).
|
|
74
|
+
* Note: When changing the `format` prop, ensure `max` is also updated to match the new format.
|
|
75
|
+
*/
|
|
76
|
+
max?: string;
|
|
77
|
+
/** Custom error message displayed when date is before the minimum date. */
|
|
78
|
+
rangeUnderflowMessage?: string;
|
|
79
|
+
/** Custom error message displayed when date is after the maximum date. */
|
|
80
|
+
rangeOverflowMessage?: string;
|
|
67
81
|
/** Custom error message displayed for any validation failures in the input. */
|
|
68
82
|
customErrorMessage?: string;
|
|
69
83
|
/** Save current value */
|
|
@@ -74,6 +88,10 @@ export declare class InputDate {
|
|
|
74
88
|
validityState: string;
|
|
75
89
|
/** Validity message passed from validateFormElement function after validation */
|
|
76
90
|
validityMessage: string;
|
|
91
|
+
/** Defines if the component has been touched by user */
|
|
92
|
+
touched: boolean;
|
|
93
|
+
/** Defines if the value has been changed by user interaction */
|
|
94
|
+
dirty: boolean;
|
|
77
95
|
/** Emits event after each validation */
|
|
78
96
|
rValidate: EventEmitter<{
|
|
79
97
|
state: string;
|
|
@@ -104,11 +122,22 @@ export declare class InputDate {
|
|
|
104
122
|
getFormat(): Promise<string>;
|
|
105
123
|
/** Sets the date format */
|
|
106
124
|
setFormat(format: string): Promise<void>;
|
|
125
|
+
/** Gets the touched state (whether user has interacted with the input) */
|
|
126
|
+
isTouched(): Promise<boolean>;
|
|
127
|
+
/** Gets the dirty state (whether value has been changed by user) */
|
|
128
|
+
isDirty(): Promise<boolean>;
|
|
129
|
+
/** Resets touched and dirty states to pristine (untouched/clean) */
|
|
130
|
+
markAsPristine(): Promise<void>;
|
|
107
131
|
/**
|
|
108
132
|
* Resets the component by clearing all input values and focusing the first input.
|
|
109
133
|
* @returns Promise that resolves when reset is complete
|
|
110
134
|
*/
|
|
111
135
|
reset(): Promise<void>;
|
|
136
|
+
/**
|
|
137
|
+
* Validates the input date without triggering UI and returns a boolean indicating its validity.
|
|
138
|
+
* @returns A boolean indicating whether the input date is valid.
|
|
139
|
+
*/
|
|
140
|
+
checkValidity(): Promise<boolean>;
|
|
112
141
|
/**
|
|
113
142
|
* Initial attributes state
|
|
114
143
|
* */
|
|
@@ -143,6 +172,7 @@ export declare class InputDate {
|
|
|
143
172
|
private handleInput;
|
|
144
173
|
private createChangeHandler;
|
|
145
174
|
private handleChange;
|
|
175
|
+
private handleBlur;
|
|
146
176
|
private getValidityStateData;
|
|
147
177
|
private validateFormElement;
|
|
148
178
|
private onResetForm;
|
|
@@ -111,6 +111,11 @@ export declare class InputPassword {
|
|
|
111
111
|
getValue(): Promise<string>;
|
|
112
112
|
/** Set the input value */
|
|
113
113
|
setValue(value: string): Promise<void>;
|
|
114
|
+
/**
|
|
115
|
+
* Validates the input password without triggering UI and returns a boolean indicating its validity.
|
|
116
|
+
* @returns A boolean indicating whether the input password is valid.
|
|
117
|
+
*/
|
|
118
|
+
checkValidity(): Promise<boolean>;
|
|
114
119
|
/**
|
|
115
120
|
* Initial attributes state
|
|
116
121
|
* */
|
|
@@ -90,6 +90,11 @@ export declare class InputPhoneNumber {
|
|
|
90
90
|
setValue(value: string): Promise<void>;
|
|
91
91
|
/** Validates an element, displays provided message in case value is invalid. */
|
|
92
92
|
setCustomValidity(message: string): Promise<void>;
|
|
93
|
+
/**
|
|
94
|
+
* Validates the input phone number without triggering UI and returns a boolean indicating its validity.
|
|
95
|
+
* @returns A boolean indicating whether the input phone number is valid.
|
|
96
|
+
*/
|
|
97
|
+
checkValidity(): Promise<boolean>;
|
|
93
98
|
/** Check validity and reveal validation state. */
|
|
94
99
|
reportValidity(): Promise<boolean>;
|
|
95
100
|
/** Reset phone number input to its initial state */
|
|
@@ -126,8 +126,7 @@ export declare class RadioGroup {
|
|
|
126
126
|
*/
|
|
127
127
|
clearValue(): Promise<void>;
|
|
128
128
|
/**
|
|
129
|
-
* Validates the radio group and returns a boolean indicating its validity.
|
|
130
|
-
*
|
|
129
|
+
* Validates the radio group without triggering UI and returns a boolean indicating its validity.
|
|
131
130
|
* @returns A boolean indicating whether the radio group is valid.
|
|
132
131
|
*/
|
|
133
132
|
checkValidity(): Promise<boolean>;
|
|
@@ -130,10 +130,13 @@ export declare class Select {
|
|
|
130
130
|
valueToDisplay: string;
|
|
131
131
|
isInitializing: boolean;
|
|
132
132
|
isResetting: boolean;
|
|
133
|
-
isNewValue: boolean;
|
|
134
133
|
focusedOption: any;
|
|
135
134
|
isValueFocused: boolean;
|
|
136
135
|
isNoResultsFound: boolean;
|
|
136
|
+
/** Indicates if the user has interacted with the select (focused/clicked) */
|
|
137
|
+
touched: boolean;
|
|
138
|
+
/** Indicates if the value has been changed by user interaction */
|
|
139
|
+
dirty: boolean;
|
|
137
140
|
/** Emits event after each validation */
|
|
138
141
|
rValidate: EventEmitter<{
|
|
139
142
|
state: string;
|
|
@@ -172,8 +175,18 @@ export declare class Select {
|
|
|
172
175
|
* and update tooltip position if needed
|
|
173
176
|
*/
|
|
174
177
|
handleResizing(): void;
|
|
175
|
-
/**
|
|
178
|
+
/**
|
|
179
|
+
* Set value of the select programmatically.
|
|
180
|
+
* Does NOT mark as dirty or emit change events.
|
|
181
|
+
* Use this for programmatic value updates.
|
|
182
|
+
*/
|
|
176
183
|
setValue(value?: string): Promise<void>;
|
|
184
|
+
/**
|
|
185
|
+
* Internal method to set value from user interaction.
|
|
186
|
+
* Assumes dirty flag is already set by the caller.
|
|
187
|
+
* Will emit rChange if dirty flag is true.
|
|
188
|
+
*/
|
|
189
|
+
private setValueFromUserInteraction;
|
|
177
190
|
/** Set value of the select */
|
|
178
191
|
getValue(): Promise<string>;
|
|
179
192
|
/** Reset select to its initial state */
|
|
@@ -182,6 +195,25 @@ export declare class Select {
|
|
|
182
195
|
* Clears validation results.
|
|
183
196
|
*/
|
|
184
197
|
resetValidation(): Promise<void>;
|
|
198
|
+
/**
|
|
199
|
+
* Returns whether the select has been touched (focused/clicked by user).
|
|
200
|
+
* @returns A boolean indicating whether the select has been touched.
|
|
201
|
+
*/
|
|
202
|
+
isTouched(): Promise<boolean>;
|
|
203
|
+
/**
|
|
204
|
+
* Returns whether the select value has been changed by user interaction.
|
|
205
|
+
* @returns A boolean indicating whether the select is dirty.
|
|
206
|
+
*/
|
|
207
|
+
isDirty(): Promise<boolean>;
|
|
208
|
+
/**
|
|
209
|
+
* Marks the select as untouched and pristine (not dirty).
|
|
210
|
+
*/
|
|
211
|
+
markAsPristine(): Promise<void>;
|
|
212
|
+
/**
|
|
213
|
+
* Validates the textarea without triggering UI and returns a boolean indicating its validity.
|
|
214
|
+
* @returns A boolean indicating whether the textarea is valid.
|
|
215
|
+
*/
|
|
216
|
+
checkValidity(): Promise<boolean>;
|
|
185
217
|
/** Check validity and reveal validation state and message */
|
|
186
218
|
reportValidity(): Promise<boolean>;
|
|
187
219
|
/** Set focus on the element */
|
|
@@ -145,6 +145,11 @@ export declare class RTextarea {
|
|
|
145
145
|
setRangeText(replacement: string, start: number, end: number, selectionMode?: 'select' | 'start' | 'end' | 'preserve'): Promise<void>;
|
|
146
146
|
/** Validates an element, displays provided message in case value is invalid. */
|
|
147
147
|
setCustomValidity(message: string): Promise<void>;
|
|
148
|
+
/**
|
|
149
|
+
* Validates the textarea without triggering UI and returns a boolean indicating its validity.
|
|
150
|
+
* @returns A boolean indicating whether the textarea is valid.
|
|
151
|
+
*/
|
|
152
|
+
checkValidity(): Promise<boolean>;
|
|
148
153
|
/** Validates an element and displays validity state. */
|
|
149
154
|
reportValidity(): Promise<void>;
|
|
150
155
|
/** Identify wrapping form element. */
|
|
@@ -11,8 +11,15 @@ export declare class Toast {
|
|
|
11
11
|
* Options are: "info", "success", "warning", or "error".
|
|
12
12
|
* @default 'info' */
|
|
13
13
|
status: ToastStatus;
|
|
14
|
+
/** Sets role="alert" and will be announced to screen reader users */
|
|
15
|
+
announced: boolean;
|
|
14
16
|
/** Specifies an optional icon for the leading slot of the dialog. */
|
|
15
17
|
leadingIcon?: IconName;
|
|
18
|
+
/**
|
|
19
|
+
* Defines whether the leading icon is visible.
|
|
20
|
+
* @default true
|
|
21
|
+
* */
|
|
22
|
+
leadingIconVisible: boolean;
|
|
16
23
|
/** Specifies an optional icon for the trailing slot of the dialog.
|
|
17
24
|
* @default 'cross'
|
|
18
25
|
* */
|
|
@@ -35,7 +42,7 @@ export declare class Toast {
|
|
|
35
42
|
* Defines the behavior of the component's dismissing.
|
|
36
43
|
* - `auto`: The component will be dismissed automatically after number of ms set by `delay` property.
|
|
37
44
|
* - `manual`: The component requires explicit user action to close.
|
|
38
|
-
* @default "
|
|
45
|
+
* @default "manual"
|
|
39
46
|
*/
|
|
40
47
|
dismissMode: ToastDismissMode;
|
|
41
48
|
/** Provides content for `aria-label` attribute of the dismiss button. */
|
|
@@ -104,7 +111,7 @@ export declare class Toast {
|
|
|
104
111
|
/** Unique id for each accordion item/row */
|
|
105
112
|
private uniqueId;
|
|
106
113
|
private hasElContent;
|
|
107
|
-
private
|
|
114
|
+
private getElContent;
|
|
108
115
|
private get hasLeadingSlot();
|
|
109
116
|
private get hasLeading();
|
|
110
117
|
private get hasTrailingSlot();
|
|
@@ -118,6 +125,7 @@ export declare class Toast {
|
|
|
118
125
|
private get hasHeadline();
|
|
119
126
|
private get hasDelay();
|
|
120
127
|
private get isError();
|
|
128
|
+
private get leadingIconName();
|
|
121
129
|
private startDelayTimer;
|
|
122
130
|
private handleTrailingButtonClick;
|
|
123
131
|
private handleSlotChange;
|
|
@@ -167,6 +167,11 @@ export namespace Components {
|
|
|
167
167
|
"splitted"?: boolean;
|
|
168
168
|
}
|
|
169
169
|
interface RAlert {
|
|
170
|
+
/**
|
|
171
|
+
* Sets role="alert" and will be announced to screen reader users
|
|
172
|
+
* @default true
|
|
173
|
+
*/
|
|
174
|
+
"announced": boolean;
|
|
170
175
|
/**
|
|
171
176
|
* Defines content text of the alert
|
|
172
177
|
*/
|
|
@@ -177,7 +182,7 @@ export namespace Components {
|
|
|
177
182
|
"delay"?: number;
|
|
178
183
|
/**
|
|
179
184
|
* Text content for an alert dismiss button
|
|
180
|
-
* @default '
|
|
185
|
+
* @default 'Dismiss alert'
|
|
181
186
|
*/
|
|
182
187
|
"dismissButtonAriaLabel": string;
|
|
183
188
|
/**
|
|
@@ -217,11 +222,12 @@ export namespace Components {
|
|
|
217
222
|
"target": AlertTarget;
|
|
218
223
|
/**
|
|
219
224
|
* Defines an icon to be presented in trailing slot
|
|
225
|
+
* @default 'cross'
|
|
220
226
|
*/
|
|
221
227
|
"trailingIcon"?: IconName;
|
|
222
228
|
/**
|
|
223
229
|
* Defines an icon size to be presented in trailing slot
|
|
224
|
-
* @default '
|
|
230
|
+
* @default 'm'
|
|
225
231
|
*/
|
|
226
232
|
"trailingIconSize": IconSize;
|
|
227
233
|
/**
|
|
@@ -323,6 +329,11 @@ export namespace Components {
|
|
|
323
329
|
* Checks the checkbox element.
|
|
324
330
|
*/
|
|
325
331
|
"check": () => Promise<void>;
|
|
332
|
+
/**
|
|
333
|
+
* Validates the checkbox without triggering UI and returns a boolean indicating its validity.
|
|
334
|
+
* @returns A boolean indicating whether the checkbox is valid.
|
|
335
|
+
*/
|
|
336
|
+
"checkValidity": () => Promise<boolean>;
|
|
326
337
|
/**
|
|
327
338
|
* Pass initial checked state
|
|
328
339
|
*/
|
|
@@ -419,6 +430,11 @@ export namespace Components {
|
|
|
419
430
|
* Checks all checkboxes in the slot.
|
|
420
431
|
*/
|
|
421
432
|
"checkAll": () => Promise<this>;
|
|
433
|
+
/**
|
|
434
|
+
* Validates the checkbox group without triggering UI and returns a boolean indicating its validity.
|
|
435
|
+
* @returns A boolean indicating whether the checkbox is valid.
|
|
436
|
+
*/
|
|
437
|
+
"checkValidity": () => Promise<boolean>;
|
|
422
438
|
/**
|
|
423
439
|
* Specifies if select-all checkbox is initially in checked state
|
|
424
440
|
*/
|
|
@@ -691,6 +707,11 @@ export namespace Components {
|
|
|
691
707
|
* Custom message for `badInput` (conversion / parsing failure).
|
|
692
708
|
*/
|
|
693
709
|
"badInputMessage"?: string;
|
|
710
|
+
/**
|
|
711
|
+
* Validates the input without triggering UI and returns a boolean indicating its validity.
|
|
712
|
+
* @returns A boolean indicating whether the input is valid.
|
|
713
|
+
*/
|
|
714
|
+
"checkValidity": () => Promise<boolean>;
|
|
694
715
|
/**
|
|
695
716
|
* Custom message for `customError` (applies when set via `setCustomValidity()` logic internally).
|
|
696
717
|
*/
|
|
@@ -917,6 +938,11 @@ export namespace Components {
|
|
|
917
938
|
* Defines label for each character's input. Default "Character: ${character number}"
|
|
918
939
|
*/
|
|
919
940
|
"ariaCharacterLabel"?: string;
|
|
941
|
+
/**
|
|
942
|
+
* Validates the input code without triggering UI and returns a boolean indicating its validity.
|
|
943
|
+
* @returns A boolean indicating whether the input code is valid.
|
|
944
|
+
*/
|
|
945
|
+
"checkValidity": () => Promise<boolean>;
|
|
920
946
|
/**
|
|
921
947
|
* Set custom message for `customError` property of a ValidityState object indicating whether the element's custom validity message has been set to a non-empty string by calling the element's setCustomValidity() method.
|
|
922
948
|
*/
|
|
@@ -1010,6 +1036,11 @@ export namespace Components {
|
|
|
1010
1036
|
"valueMissingMessage"?: string;
|
|
1011
1037
|
}
|
|
1012
1038
|
interface RInputDate {
|
|
1039
|
+
/**
|
|
1040
|
+
* Validates the input date without triggering UI and returns a boolean indicating its validity.
|
|
1041
|
+
* @returns A boolean indicating whether the input date is valid.
|
|
1042
|
+
*/
|
|
1043
|
+
"checkValidity": () => Promise<boolean>;
|
|
1013
1044
|
/**
|
|
1014
1045
|
* Custom error message displayed for any validation failures in the input.
|
|
1015
1046
|
*/
|
|
@@ -1064,10 +1095,30 @@ export namespace Components {
|
|
|
1064
1095
|
* Custom error message displayed when date is not valid.
|
|
1065
1096
|
*/
|
|
1066
1097
|
"invalidDateMessage"?: string;
|
|
1098
|
+
/**
|
|
1099
|
+
* Gets the dirty state (whether value has been changed by user)
|
|
1100
|
+
*/
|
|
1101
|
+
"isDirty": () => Promise<boolean>;
|
|
1102
|
+
/**
|
|
1103
|
+
* Gets the touched state (whether user has interacted with the input)
|
|
1104
|
+
*/
|
|
1105
|
+
"isTouched": () => Promise<boolean>;
|
|
1067
1106
|
/**
|
|
1068
1107
|
* The text on the label
|
|
1069
1108
|
*/
|
|
1070
1109
|
"label": string;
|
|
1110
|
+
/**
|
|
1111
|
+
* Resets touched and dirty states to pristine (untouched/clean)
|
|
1112
|
+
*/
|
|
1113
|
+
"markAsPristine": () => Promise<void>;
|
|
1114
|
+
/**
|
|
1115
|
+
* Maximum date value (in the same format as the date input). Note: When changing the `format` prop, ensure `max` is also updated to match the new format.
|
|
1116
|
+
*/
|
|
1117
|
+
"max"?: string;
|
|
1118
|
+
/**
|
|
1119
|
+
* Minimum date value (in the same format as the date input). Note: When changing the `format` prop, ensure `min` is also updated to match the new format.
|
|
1120
|
+
*/
|
|
1121
|
+
"min"?: string;
|
|
1071
1122
|
/**
|
|
1072
1123
|
* Defines label for the input for the month
|
|
1073
1124
|
* @default 'Month'
|
|
@@ -1081,6 +1132,14 @@ export namespace Components {
|
|
|
1081
1132
|
* Specifies if element must be ignored during validation of the form elements
|
|
1082
1133
|
*/
|
|
1083
1134
|
"novalidate"?: boolean;
|
|
1135
|
+
/**
|
|
1136
|
+
* Custom error message displayed when date is after the maximum date.
|
|
1137
|
+
*/
|
|
1138
|
+
"rangeOverflowMessage"?: string;
|
|
1139
|
+
/**
|
|
1140
|
+
* Custom error message displayed when date is before the minimum date.
|
|
1141
|
+
*/
|
|
1142
|
+
"rangeUnderflowMessage"?: string;
|
|
1084
1143
|
/**
|
|
1085
1144
|
* Makes the date inputs read-only: users can focus and copy the value, but cannot modify it (value still submitted with the form unlike disabled).
|
|
1086
1145
|
*/
|
|
@@ -1134,6 +1193,11 @@ export namespace Components {
|
|
|
1134
1193
|
"yearAriaLabel": string;
|
|
1135
1194
|
}
|
|
1136
1195
|
interface RInputPassword {
|
|
1196
|
+
/**
|
|
1197
|
+
* Validates the input password without triggering UI and returns a boolean indicating its validity.
|
|
1198
|
+
* @returns A boolean indicating whether the input password is valid.
|
|
1199
|
+
*/
|
|
1200
|
+
"checkValidity": () => Promise<boolean>;
|
|
1137
1201
|
/**
|
|
1138
1202
|
* Custom error message displayed for any validation failures in the input.
|
|
1139
1203
|
*/
|
|
@@ -1257,6 +1321,11 @@ export namespace Components {
|
|
|
1257
1321
|
"valueMissingMessage"?: string;
|
|
1258
1322
|
}
|
|
1259
1323
|
interface RInputPhoneNumber {
|
|
1324
|
+
/**
|
|
1325
|
+
* Validates the input phone number without triggering UI and returns a boolean indicating its validity.
|
|
1326
|
+
* @returns A boolean indicating whether the input phone number is valid.
|
|
1327
|
+
*/
|
|
1328
|
+
"checkValidity": () => Promise<boolean>;
|
|
1260
1329
|
/**
|
|
1261
1330
|
* Label for countryCode code
|
|
1262
1331
|
* @default 'Country code'
|
|
@@ -1801,7 +1870,7 @@ export namespace Components {
|
|
|
1801
1870
|
}
|
|
1802
1871
|
interface RRadioGroup {
|
|
1803
1872
|
/**
|
|
1804
|
-
* Validates the radio group and returns a boolean indicating its validity.
|
|
1873
|
+
* Validates the radio group without triggering UI and returns a boolean indicating its validity.
|
|
1805
1874
|
* @returns A boolean indicating whether the radio group is valid.
|
|
1806
1875
|
*/
|
|
1807
1876
|
"checkValidity": () => Promise<boolean>;
|
|
@@ -1928,6 +1997,11 @@ export namespace Components {
|
|
|
1928
1997
|
* Overall behavior is based on native `<select>`
|
|
1929
1998
|
*/
|
|
1930
1999
|
interface RSelect {
|
|
2000
|
+
/**
|
|
2001
|
+
* Validates the textarea without triggering UI and returns a boolean indicating its validity.
|
|
2002
|
+
* @returns A boolean indicating whether the textarea is valid.
|
|
2003
|
+
*/
|
|
2004
|
+
"checkValidity": () => Promise<boolean>;
|
|
1931
2005
|
/**
|
|
1932
2006
|
* Clears readonly state from the component
|
|
1933
2007
|
*/
|
|
@@ -1998,6 +2072,16 @@ export namespace Components {
|
|
|
1998
2072
|
* Validity indicator, serving to change UI of the component
|
|
1999
2073
|
*/
|
|
2000
2074
|
"invalid"?: boolean;
|
|
2075
|
+
/**
|
|
2076
|
+
* Returns whether the select value has been changed by user interaction.
|
|
2077
|
+
* @returns A boolean indicating whether the select is dirty.
|
|
2078
|
+
*/
|
|
2079
|
+
"isDirty": () => Promise<boolean>;
|
|
2080
|
+
/**
|
|
2081
|
+
* Returns whether the select has been touched (focused/clicked by user).
|
|
2082
|
+
* @returns A boolean indicating whether the select has been touched.
|
|
2083
|
+
*/
|
|
2084
|
+
"isTouched": () => Promise<boolean>;
|
|
2001
2085
|
/**
|
|
2002
2086
|
* The text on the label
|
|
2003
2087
|
*/
|
|
@@ -2020,6 +2104,10 @@ export namespace Components {
|
|
|
2020
2104
|
* @default 'bottom'
|
|
2021
2105
|
*/
|
|
2022
2106
|
"listboxPosition": ListboxPosition;
|
|
2107
|
+
/**
|
|
2108
|
+
* Marks the select as untouched and pristine (not dirty).
|
|
2109
|
+
*/
|
|
2110
|
+
"markAsPristine": () => Promise<void>;
|
|
2023
2111
|
/**
|
|
2024
2112
|
* Name of element (data) within a form
|
|
2025
2113
|
*/
|
|
@@ -2084,7 +2172,7 @@ export namespace Components {
|
|
|
2084
2172
|
*/
|
|
2085
2173
|
"setReadonly": () => Promise<void>;
|
|
2086
2174
|
/**
|
|
2087
|
-
* Set value of the select
|
|
2175
|
+
* Set value of the select programmatically. Does NOT mark as dirty or emit change events. Use this for programmatic value updates.
|
|
2088
2176
|
*/
|
|
2089
2177
|
"setValue": (value?: string) => Promise<void>;
|
|
2090
2178
|
/**
|
|
@@ -2300,6 +2388,11 @@ export namespace Components {
|
|
|
2300
2388
|
* @default "You've reached the character limit."
|
|
2301
2389
|
*/
|
|
2302
2390
|
"characterLimitReachedMessage": string;
|
|
2391
|
+
/**
|
|
2392
|
+
* Validates the textarea without triggering UI and returns a boolean indicating its validity.
|
|
2393
|
+
* @returns A boolean indicating whether the textarea is valid.
|
|
2394
|
+
*/
|
|
2395
|
+
"checkValidity": () => Promise<boolean>;
|
|
2303
2396
|
/**
|
|
2304
2397
|
* Specifies the visible width of the `<textarea>` in terms of the number of characters.
|
|
2305
2398
|
*/
|
|
@@ -2470,6 +2563,11 @@ export namespace Components {
|
|
|
2470
2563
|
* Specifies the text content for the call-to-action link.
|
|
2471
2564
|
*/
|
|
2472
2565
|
"action"?: string;
|
|
2566
|
+
/**
|
|
2567
|
+
* Sets role="alert" and will be announced to screen reader users
|
|
2568
|
+
* @default true
|
|
2569
|
+
*/
|
|
2570
|
+
"announced": boolean;
|
|
2473
2571
|
/**
|
|
2474
2572
|
* Specifies the time in miliseconds before the alert automatically collapses.
|
|
2475
2573
|
* @default 3000
|
|
@@ -2491,7 +2589,7 @@ export namespace Components {
|
|
|
2491
2589
|
"dismissLabel": string;
|
|
2492
2590
|
/**
|
|
2493
2591
|
* Defines the behavior of the component's dismissing. - `auto`: The component will be dismissed automatically after number of ms set by `delay` property. - `manual`: The component requires explicit user action to close.
|
|
2494
|
-
* @default "
|
|
2592
|
+
* @default "manual"
|
|
2495
2593
|
*/
|
|
2496
2594
|
"dismissMode": ToastDismissMode;
|
|
2497
2595
|
/**
|
|
@@ -2514,6 +2612,11 @@ export namespace Components {
|
|
|
2514
2612
|
* Specifies an optional icon for the leading slot of the dialog.
|
|
2515
2613
|
*/
|
|
2516
2614
|
"leadingIcon"?: IconName;
|
|
2615
|
+
/**
|
|
2616
|
+
* Defines whether the leading icon is visible.
|
|
2617
|
+
* @default true
|
|
2618
|
+
*/
|
|
2619
|
+
"leadingIconVisible": boolean;
|
|
2517
2620
|
/**
|
|
2518
2621
|
* Controls if toast is initially shown.
|
|
2519
2622
|
* @default true
|
|
@@ -3711,6 +3814,11 @@ declare namespace LocalJSX {
|
|
|
3711
3814
|
"splitted"?: boolean;
|
|
3712
3815
|
}
|
|
3713
3816
|
interface RAlert {
|
|
3817
|
+
/**
|
|
3818
|
+
* Sets role="alert" and will be announced to screen reader users
|
|
3819
|
+
* @default true
|
|
3820
|
+
*/
|
|
3821
|
+
"announced"?: boolean;
|
|
3714
3822
|
/**
|
|
3715
3823
|
* Defines content text of the alert
|
|
3716
3824
|
*/
|
|
@@ -3721,7 +3829,7 @@ declare namespace LocalJSX {
|
|
|
3721
3829
|
"delay"?: number;
|
|
3722
3830
|
/**
|
|
3723
3831
|
* Text content for an alert dismiss button
|
|
3724
|
-
* @default '
|
|
3832
|
+
* @default 'Dismiss alert'
|
|
3725
3833
|
*/
|
|
3726
3834
|
"dismissButtonAriaLabel"?: string;
|
|
3727
3835
|
/**
|
|
@@ -3765,11 +3873,12 @@ declare namespace LocalJSX {
|
|
|
3765
3873
|
"target"?: AlertTarget;
|
|
3766
3874
|
/**
|
|
3767
3875
|
* Defines an icon to be presented in trailing slot
|
|
3876
|
+
* @default 'cross'
|
|
3768
3877
|
*/
|
|
3769
3878
|
"trailingIcon"?: IconName;
|
|
3770
3879
|
/**
|
|
3771
3880
|
* Defines an icon size to be presented in trailing slot
|
|
3772
|
-
* @default '
|
|
3881
|
+
* @default 'm'
|
|
3773
3882
|
*/
|
|
3774
3883
|
"trailingIconSize"?: IconSize;
|
|
3775
3884
|
/**
|
|
@@ -4578,6 +4687,14 @@ declare namespace LocalJSX {
|
|
|
4578
4687
|
* The text on the label
|
|
4579
4688
|
*/
|
|
4580
4689
|
"label": string;
|
|
4690
|
+
/**
|
|
4691
|
+
* Maximum date value (in the same format as the date input). Note: When changing the `format` prop, ensure `max` is also updated to match the new format.
|
|
4692
|
+
*/
|
|
4693
|
+
"max"?: string;
|
|
4694
|
+
/**
|
|
4695
|
+
* Minimum date value (in the same format as the date input). Note: When changing the `format` prop, ensure `min` is also updated to match the new format.
|
|
4696
|
+
*/
|
|
4697
|
+
"min"?: string;
|
|
4581
4698
|
/**
|
|
4582
4699
|
* Defines label for the input for the month
|
|
4583
4700
|
* @default 'Month'
|
|
@@ -4619,6 +4736,14 @@ declare namespace LocalJSX {
|
|
|
4619
4736
|
state: string,
|
|
4620
4737
|
message: string
|
|
4621
4738
|
}>) => void;
|
|
4739
|
+
/**
|
|
4740
|
+
* Custom error message displayed when date is after the maximum date.
|
|
4741
|
+
*/
|
|
4742
|
+
"rangeOverflowMessage"?: string;
|
|
4743
|
+
/**
|
|
4744
|
+
* Custom error message displayed when date is before the minimum date.
|
|
4745
|
+
*/
|
|
4746
|
+
"rangeUnderflowMessage"?: string;
|
|
4622
4747
|
/**
|
|
4623
4748
|
* Makes the date inputs read-only: users can focus and copy the value, but cannot modify it (value still submitted with the form unlike disabled).
|
|
4624
4749
|
*/
|
|
@@ -5964,6 +6089,11 @@ declare namespace LocalJSX {
|
|
|
5964
6089
|
* Specifies the text content for the call-to-action link.
|
|
5965
6090
|
*/
|
|
5966
6091
|
"action"?: string;
|
|
6092
|
+
/**
|
|
6093
|
+
* Sets role="alert" and will be announced to screen reader users
|
|
6094
|
+
* @default true
|
|
6095
|
+
*/
|
|
6096
|
+
"announced"?: boolean;
|
|
5967
6097
|
/**
|
|
5968
6098
|
* Specifies the time in miliseconds before the alert automatically collapses.
|
|
5969
6099
|
* @default 3000
|
|
@@ -5981,7 +6111,7 @@ declare namespace LocalJSX {
|
|
|
5981
6111
|
"dismissLabel"?: string;
|
|
5982
6112
|
/**
|
|
5983
6113
|
* Defines the behavior of the component's dismissing. - `auto`: The component will be dismissed automatically after number of ms set by `delay` property. - `manual`: The component requires explicit user action to close.
|
|
5984
|
-
* @default "
|
|
6114
|
+
* @default "manual"
|
|
5985
6115
|
*/
|
|
5986
6116
|
"dismissMode"?: ToastDismissMode;
|
|
5987
6117
|
/**
|
|
@@ -6000,6 +6130,11 @@ declare namespace LocalJSX {
|
|
|
6000
6130
|
* Specifies an optional icon for the leading slot of the dialog.
|
|
6001
6131
|
*/
|
|
6002
6132
|
"leadingIcon"?: IconName;
|
|
6133
|
+
/**
|
|
6134
|
+
* Defines whether the leading icon is visible.
|
|
6135
|
+
* @default true
|
|
6136
|
+
*/
|
|
6137
|
+
"leadingIconVisible"?: boolean;
|
|
6003
6138
|
/**
|
|
6004
6139
|
* Emitted when the toast is dismissed and scheduled for removal from the DOM. Fired by dismiss(), by the auto-dismiss timer (delay), and by the trailing dismiss button. Use this to react to permanent removal (contrast with toastHide which only hides without removal).
|
|
6005
6140
|
*/
|