@warp-ds/elements 2.9.1 → 2.10.0-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/custom-elements.json +347 -284
- package/dist/docs/button/accessibility.md +42 -0
- package/dist/docs/button/api.md +63 -39
- package/dist/docs/button/button.md +322 -40
- package/dist/docs/button/examples.md +126 -0
- package/dist/docs/button/usage.md +89 -0
- package/dist/docs/modal/accessibility.md +1 -0
- package/dist/docs/modal/api.md +51 -0
- package/dist/docs/modal/examples.md +67 -0
- package/dist/docs/modal/modal.md +238 -0
- package/dist/docs/modal/usage.md +110 -0
- package/dist/docs/modal-footer/accessibility.md +1 -0
- package/dist/docs/modal-footer/api.md +11 -0
- package/dist/docs/modal-footer/examples.md +1 -0
- package/dist/docs/modal-footer/modal-footer.md +23 -0
- package/dist/docs/modal-footer/usage.md +1 -0
- package/dist/docs/modal-header/accessibility.md +1 -0
- package/dist/docs/modal-header/api.md +42 -0
- package/dist/docs/modal-header/examples.md +1 -0
- package/dist/docs/modal-header/modal-header.md +54 -0
- package/dist/docs/modal-header/usage.md +1 -0
- package/dist/docs/page-indicator/api.md +6 -6
- package/dist/docs/page-indicator/examples.md +8 -0
- package/dist/docs/page-indicator/page-indicator.md +23 -6
- package/dist/docs/page-indicator/usage.md +8 -0
- package/dist/docs/pagination/api.md +12 -10
- package/dist/docs/pagination/examples.md +20 -0
- package/dist/docs/pagination/pagination.md +50 -12
- package/dist/docs/pagination/usage.md +18 -0
- package/dist/docs/pill/accessibility.md +2 -0
- package/dist/docs/pill/api.md +10 -26
- package/dist/docs/pill/examples.md +23 -0
- package/dist/docs/pill/pill.md +43 -28
- package/dist/docs/pill/usage.md +8 -0
- package/dist/docs/radio/accessibility.md +1 -0
- package/dist/docs/radio/api.md +57 -0
- package/dist/docs/radio/examples.md +1 -0
- package/dist/docs/radio/radio.md +69 -0
- package/dist/docs/radio/usage.md +1 -0
- package/dist/docs/radio-group/accessibility.md +1 -0
- package/dist/docs/radio-group/api.md +69 -0
- package/dist/docs/radio-group/examples.md +68 -0
- package/dist/docs/radio-group/radio-group.md +311 -0
- package/dist/docs/radio-group/styling.md +118 -0
- package/dist/docs/radio-group/usage.md +44 -0
- package/dist/docs/select/accessibility.md +2 -0
- package/dist/docs/select/api.md +20 -16
- package/dist/docs/select/examples.md +116 -0
- package/dist/docs/select/select.md +168 -18
- package/dist/docs/select/usage.md +30 -0
- package/dist/index.d.ts +441 -474
- package/dist/packages/attention/attention.js +23 -21
- package/dist/packages/attention/attention.js.map +3 -3
- package/dist/packages/button/button.d.ts +54 -37
- package/dist/packages/button/button.js +17 -15
- package/dist/packages/button/button.js.map +3 -3
- package/dist/packages/button/button.react.stories.d.ts +2 -2
- package/dist/packages/button/react.d.ts +1 -1
- package/dist/packages/modal/index.d.ts +4 -4
- package/dist/packages/modal/index.js +4 -4
- package/dist/packages/modal/modal.d.ts +21 -12
- package/dist/packages/modal/modal.js +4 -4
- package/dist/packages/modal/modal.js.map +3 -3
- package/dist/packages/modal/modal.react.stories.d.ts +3 -3
- package/dist/packages/modal/modal.stories.d.ts +2 -1
- package/dist/packages/modal/modal.stories.js +85 -3
- package/dist/packages/modal/react.d.ts +2 -2
- package/dist/packages/modal-footer/modal-footer.d.ts +5 -3
- package/dist/packages/modal-footer/modal-footer.js +4 -4
- package/dist/packages/modal-footer/modal-footer.js.map +3 -3
- package/dist/packages/modal-footer/react.d.ts +1 -1
- package/dist/packages/modal-header/modal-header.d.ts +21 -11
- package/dist/packages/modal-header/modal-header.js +1 -1
- package/dist/packages/modal-header/modal-header.js.map +3 -3
- package/dist/packages/modal-header/react.d.ts +2 -2
- package/dist/packages/page-indicator/page-indicator.d.ts +9 -14
- package/dist/packages/page-indicator/page-indicator.js.map +2 -2
- package/dist/packages/pagination/pagination.d.ts +11 -11
- package/dist/packages/pagination/pagination.js.map +2 -2
- package/dist/packages/pill/pill.d.ts +14 -29
- package/dist/packages/pill/pill.js.map +2 -2
- package/dist/packages/pill/pill.react.stories.d.ts +2 -2
- package/dist/packages/pill/react.d.ts +1 -1
- package/dist/packages/radio/radio.d.ts +51 -13
- package/dist/packages/radio/radio.js +3 -3
- package/dist/packages/radio/radio.js.map +3 -3
- package/dist/packages/radio/radio.react.stories.d.ts +1 -1
- package/dist/packages/radio/radio.stories.d.ts +2 -2
- package/dist/packages/radio/react.d.ts +2 -2
- package/dist/packages/radio-group/radio-group.d.ts +43 -5
- package/dist/packages/radio-group/radio-group.js +7 -7
- package/dist/packages/radio-group/radio-group.js.map +3 -3
- package/dist/packages/radio-group/react.d.ts +4 -4
- package/dist/packages/select/select.d.ts +32 -48
- package/dist/packages/select/select.js.map +2 -2
- package/dist/web-types.json +349 -115
- package/package.json +5 -5
package/dist/index.d.ts
CHANGED
|
@@ -14,14 +14,23 @@ import type { WCheckboxGroup } from "./packages/checkbox-group/checkbox-group.ts
|
|
|
14
14
|
import type { WarpCombobox } from "./packages/combobox/combobox.ts";
|
|
15
15
|
import type { WarpDatepicker } from "./packages/datepicker/datepicker.ts";
|
|
16
16
|
import type { WarpExpandable } from "./packages/expandable/expandable.ts";
|
|
17
|
-
import type { ModalMain } from "./packages/modal/modal.ts";
|
|
18
|
-
import type {
|
|
19
|
-
|
|
17
|
+
import type { WarpModal, ModalMain } from "./packages/modal/modal.ts";
|
|
18
|
+
import type {
|
|
19
|
+
WarpModalFooter,
|
|
20
|
+
ModalFooter,
|
|
21
|
+
} from "./packages/modal-footer/modal-footer.ts";
|
|
22
|
+
import type {
|
|
23
|
+
WarpModalHeader,
|
|
24
|
+
ModalHeader,
|
|
25
|
+
} from "./packages/modal-header/modal-header.ts";
|
|
20
26
|
import type { WarpPageIndicator } from "./packages/page-indicator/page-indicator.ts";
|
|
21
27
|
import type { WarpPagination } from "./packages/pagination/pagination.ts";
|
|
22
28
|
import type { WarpPill } from "./packages/pill/pill.ts";
|
|
23
|
-
import type { WRadio } from "./packages/radio/radio.ts";
|
|
24
|
-
import type {
|
|
29
|
+
import type { WarpRadio, WRadio } from "./packages/radio/radio.ts";
|
|
30
|
+
import type {
|
|
31
|
+
WarpRadioGroup,
|
|
32
|
+
WRadioGroup,
|
|
33
|
+
} from "./packages/radio-group/radio-group.ts";
|
|
25
34
|
import type { WarpSelect } from "./packages/select/select.ts";
|
|
26
35
|
import type { WarpSliderThumb } from "./packages/slider-thumb/slider-thumb.ts";
|
|
27
36
|
import type { WarpSlider } from "./packages/slider/slider.ts";
|
|
@@ -381,85 +390,125 @@ export type WarpLinkSolidJsProps = {
|
|
|
381
390
|
};
|
|
382
391
|
|
|
383
392
|
export type WarpButtonProps = {
|
|
384
|
-
/**
|
|
393
|
+
/** Native button type.
|
|
394
|
+
Controls whether the internal button behaves as a regular button, submits a form, or resets a form. Defaults to `button`. */
|
|
385
395
|
type?: WarpButton["type"];
|
|
386
|
-
/**
|
|
396
|
+
/** Focuses the button when it is first rendered.
|
|
397
|
+
Applies only when the component renders a native button. Link buttons with `href` do not autofocus through this component. */
|
|
387
398
|
autofocus?: WarpButton["autofocus"];
|
|
388
|
-
/**
|
|
399
|
+
/** Visual style of the button.
|
|
400
|
+
Defaults to `secondary`. Use the variant that matches the action priority, risk, and placement. */
|
|
389
401
|
variant?: WarpButton["variant"];
|
|
390
|
-
/** @deprecated Use `variant="quiet"` instead
|
|
402
|
+
/** @deprecated Use `variant="quiet"` instead - Deprecated quiet visual treatment flag
|
|
403
|
+
Use `variant="quiet"` instead. */
|
|
391
404
|
quiet?: WarpButton["quiet"];
|
|
392
|
-
/**
|
|
405
|
+
/** Marks the button as icon-only.
|
|
406
|
+
Use this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name. */
|
|
393
407
|
"icon-only"?: WarpButton["iconOnly"];
|
|
394
|
-
/**
|
|
408
|
+
/** Marks the button as icon-only.
|
|
409
|
+
Use this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name. */
|
|
395
410
|
iconOnly?: WarpButton["iconOnly"];
|
|
396
|
-
/**
|
|
411
|
+
/** Renders the compact button size.
|
|
412
|
+
Use this in dense layouts where the default button size is too large. */
|
|
397
413
|
small?: WarpButton["small"];
|
|
398
|
-
/**
|
|
414
|
+
/** Shows the loading state.
|
|
415
|
+
Use after the user has triggered an action and the action is in progress. */
|
|
399
416
|
loading?: WarpButton["loading"];
|
|
400
|
-
/**
|
|
417
|
+
/** URL for rendering the button as a link.
|
|
418
|
+
When set, the component renders `w-link` instead of a native `button`. */
|
|
401
419
|
href?: WarpButton["href"];
|
|
402
|
-
/**
|
|
420
|
+
/** Link browsing context.
|
|
421
|
+
Passed to the rendered link when `href` is set. */
|
|
403
422
|
target?: WarpButton["target"];
|
|
404
|
-
/**
|
|
423
|
+
/** Visually disables the button.
|
|
424
|
+
Disabled buttons are discouraged because they can hide the reason an action is unavailable. */
|
|
405
425
|
disabled?: WarpButton["disabled"];
|
|
406
|
-
/**
|
|
426
|
+
/** Link relationship.
|
|
427
|
+
Passed to the rendered link when `href` is set. If `target="_blank"` is set and `rel` is omitted, `noopener` is used. */
|
|
407
428
|
rel?: WarpButton["rel"];
|
|
408
|
-
/**
|
|
429
|
+
/** Makes the button fill its parent width.
|
|
430
|
+
Useful in narrow layouts where the button should span the available inline space. */
|
|
409
431
|
"full-width"?: WarpButton["fullWidth"];
|
|
410
|
-
/**
|
|
432
|
+
/** Makes the button fill its parent width.
|
|
433
|
+
Useful in narrow layouts where the button should span the available inline space. */
|
|
411
434
|
fullWidth?: WarpButton["fullWidth"];
|
|
412
|
-
/** @deprecated This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button.
|
|
435
|
+
/** @deprecated This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button. - Deprecated class applied to the internal control
|
|
436
|
+
This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance. */
|
|
413
437
|
"button-class"?: WarpButton["buttonClass"];
|
|
414
|
-
/** @deprecated This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button.
|
|
438
|
+
/** @deprecated This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button. - Deprecated class applied to the internal control
|
|
439
|
+
This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance. */
|
|
415
440
|
buttonClass?: WarpButton["buttonClass"];
|
|
416
|
-
/**
|
|
441
|
+
/** Form control name.
|
|
442
|
+
Used when the button participates in form handling. */
|
|
417
443
|
name?: WarpButton["name"];
|
|
418
|
-
/**
|
|
444
|
+
/** Form control value.
|
|
445
|
+
Used with `name` when the button participates in form handling. Resets to its initial value when the form is reset. */
|
|
419
446
|
value?: WarpButton["value"];
|
|
420
|
-
/**
|
|
421
|
-
|
|
447
|
+
/** The [commandfor HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands. */
|
|
448
|
+
commandfor?: WarpButton["commandfor"];
|
|
449
|
+
/** The [command HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands. */
|
|
450
|
+
command?: WarpButton["command"];
|
|
422
451
|
};
|
|
423
452
|
|
|
424
453
|
export type WarpButtonSolidJsProps = {
|
|
425
|
-
/**
|
|
454
|
+
/** Native button type.
|
|
455
|
+
Controls whether the internal button behaves as a regular button, submits a form, or resets a form. Defaults to `button`. */
|
|
426
456
|
"prop:type"?: WarpButton["type"];
|
|
427
|
-
/**
|
|
457
|
+
/** Focuses the button when it is first rendered.
|
|
458
|
+
Applies only when the component renders a native button. Link buttons with `href` do not autofocus through this component. */
|
|
428
459
|
"prop:autofocus"?: WarpButton["autofocus"];
|
|
429
|
-
/**
|
|
460
|
+
/** Visual style of the button.
|
|
461
|
+
Defaults to `secondary`. Use the variant that matches the action priority, risk, and placement. */
|
|
430
462
|
"prop:variant"?: WarpButton["variant"];
|
|
431
|
-
/** @deprecated Use `variant="quiet"` instead
|
|
463
|
+
/** @deprecated Use `variant="quiet"` instead - Deprecated quiet visual treatment flag
|
|
464
|
+
Use `variant="quiet"` instead. */
|
|
432
465
|
"prop:quiet"?: WarpButton["quiet"];
|
|
433
|
-
/**
|
|
466
|
+
/** Marks the button as icon-only.
|
|
467
|
+
Use this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name. */
|
|
434
468
|
"bool:icon-only"?: WarpButton["iconOnly"];
|
|
435
|
-
/**
|
|
469
|
+
/** Marks the button as icon-only.
|
|
470
|
+
Use this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name. */
|
|
436
471
|
"prop:iconOnly"?: WarpButton["iconOnly"];
|
|
437
|
-
/**
|
|
472
|
+
/** Renders the compact button size.
|
|
473
|
+
Use this in dense layouts where the default button size is too large. */
|
|
438
474
|
"prop:small"?: WarpButton["small"];
|
|
439
|
-
/**
|
|
475
|
+
/** Shows the loading state.
|
|
476
|
+
Use after the user has triggered an action and the action is in progress. */
|
|
440
477
|
"prop:loading"?: WarpButton["loading"];
|
|
441
|
-
/**
|
|
478
|
+
/** URL for rendering the button as a link.
|
|
479
|
+
When set, the component renders `w-link` instead of a native `button`. */
|
|
442
480
|
"prop:href"?: WarpButton["href"];
|
|
443
|
-
/**
|
|
481
|
+
/** Link browsing context.
|
|
482
|
+
Passed to the rendered link when `href` is set. */
|
|
444
483
|
"prop:target"?: WarpButton["target"];
|
|
445
|
-
/**
|
|
484
|
+
/** Visually disables the button.
|
|
485
|
+
Disabled buttons are discouraged because they can hide the reason an action is unavailable. */
|
|
446
486
|
"prop:disabled"?: WarpButton["disabled"];
|
|
447
|
-
/**
|
|
487
|
+
/** Link relationship.
|
|
488
|
+
Passed to the rendered link when `href` is set. If `target="_blank"` is set and `rel` is omitted, `noopener` is used. */
|
|
448
489
|
"prop:rel"?: WarpButton["rel"];
|
|
449
|
-
/**
|
|
490
|
+
/** Makes the button fill its parent width.
|
|
491
|
+
Useful in narrow layouts where the button should span the available inline space. */
|
|
450
492
|
"bool:full-width"?: WarpButton["fullWidth"];
|
|
451
|
-
/**
|
|
493
|
+
/** Makes the button fill its parent width.
|
|
494
|
+
Useful in narrow layouts where the button should span the available inline space. */
|
|
452
495
|
"prop:fullWidth"?: WarpButton["fullWidth"];
|
|
453
|
-
/** @deprecated This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button.
|
|
496
|
+
/** @deprecated This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button. - Deprecated class applied to the internal control
|
|
497
|
+
This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance. */
|
|
454
498
|
"attr:button-class"?: WarpButton["buttonClass"];
|
|
455
|
-
/** @deprecated This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button.
|
|
499
|
+
/** @deprecated This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button. - Deprecated class applied to the internal control
|
|
500
|
+
This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance. */
|
|
456
501
|
"prop:buttonClass"?: WarpButton["buttonClass"];
|
|
457
|
-
/**
|
|
502
|
+
/** Form control name.
|
|
503
|
+
Used when the button participates in form handling. */
|
|
458
504
|
"prop:name"?: WarpButton["name"];
|
|
459
|
-
/**
|
|
505
|
+
/** Form control value.
|
|
506
|
+
Used with `name` when the button participates in form handling. Resets to its initial value when the form is reset. */
|
|
460
507
|
"prop:value"?: WarpButton["value"];
|
|
461
|
-
/**
|
|
462
|
-
"prop:
|
|
508
|
+
/** The [commandfor HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands. */
|
|
509
|
+
"prop:commandfor"?: WarpButton["commandfor"];
|
|
510
|
+
/** The [command HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands. */
|
|
511
|
+
"prop:command"?: WarpButton["command"];
|
|
463
512
|
|
|
464
513
|
/** Set the innerHTML of the element */
|
|
465
514
|
innerHTML?: string;
|
|
@@ -1076,23 +1125,19 @@ export type WarpExpandableSolidJsProps = {
|
|
|
1076
1125
|
textContent?: string | number;
|
|
1077
1126
|
};
|
|
1078
1127
|
|
|
1079
|
-
export type
|
|
1080
|
-
/**
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
/** */
|
|
1085
|
-
contentId?: ModalMain["contentId"];
|
|
1086
|
-
/** */
|
|
1087
|
-
"ignore-backdrop-clicks"?: ModalMain["ignoreBackdropClicks"];
|
|
1088
|
-
/** */
|
|
1089
|
-
ignoreBackdropClicks?: ModalMain["ignoreBackdropClicks"];
|
|
1090
|
-
/** */
|
|
1091
|
-
dialogEl?: ModalMain["dialogEl"];
|
|
1128
|
+
export type WarpModalProps = {
|
|
1129
|
+
/** Controls if the modal should show or hide.
|
|
1130
|
+
|
|
1131
|
+
You can also call the `open()` and `close()` methods. */
|
|
1132
|
+
show?: WarpModal["show"];
|
|
1092
1133
|
/** */
|
|
1093
|
-
|
|
1134
|
+
"content-id"?: WarpModal["contentId"];
|
|
1094
1135
|
/** */
|
|
1095
|
-
|
|
1136
|
+
contentId?: WarpModal["contentId"];
|
|
1137
|
+
/** Ignores clicks to the backdrop when set */
|
|
1138
|
+
"ignore-backdrop-clicks"?: WarpModal["ignoreBackdropClicks"];
|
|
1139
|
+
/** Ignores clicks to the backdrop when set */
|
|
1140
|
+
ignoreBackdropClicks?: WarpModal["ignoreBackdropClicks"];
|
|
1096
1141
|
|
|
1097
1142
|
/** */
|
|
1098
1143
|
onshown?: (e: CustomEvent) => void;
|
|
@@ -1100,23 +1145,19 @@ export type ModalMainProps = {
|
|
|
1100
1145
|
onhidden?: (e: CustomEvent) => void;
|
|
1101
1146
|
};
|
|
1102
1147
|
|
|
1103
|
-
export type
|
|
1104
|
-
/**
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
"
|
|
1108
|
-
/** */
|
|
1109
|
-
"prop:contentId"?: ModalMain["contentId"];
|
|
1110
|
-
/** */
|
|
1111
|
-
"bool:ignore-backdrop-clicks"?: ModalMain["ignoreBackdropClicks"];
|
|
1112
|
-
/** */
|
|
1113
|
-
"prop:ignoreBackdropClicks"?: ModalMain["ignoreBackdropClicks"];
|
|
1114
|
-
/** */
|
|
1115
|
-
"prop:dialogEl"?: ModalMain["dialogEl"];
|
|
1148
|
+
export type WarpModalSolidJsProps = {
|
|
1149
|
+
/** Controls if the modal should show or hide.
|
|
1150
|
+
|
|
1151
|
+
You can also call the `open()` and `close()` methods. */
|
|
1152
|
+
"prop:show"?: WarpModal["show"];
|
|
1116
1153
|
/** */
|
|
1117
|
-
"
|
|
1154
|
+
"attr:content-id"?: WarpModal["contentId"];
|
|
1118
1155
|
/** */
|
|
1119
|
-
"prop:
|
|
1156
|
+
"prop:contentId"?: WarpModal["contentId"];
|
|
1157
|
+
/** Ignores clicks to the backdrop when set */
|
|
1158
|
+
"bool:ignore-backdrop-clicks"?: WarpModal["ignoreBackdropClicks"];
|
|
1159
|
+
/** Ignores clicks to the backdrop when set */
|
|
1160
|
+
"prop:ignoreBackdropClicks"?: WarpModal["ignoreBackdropClicks"];
|
|
1120
1161
|
/** */
|
|
1121
1162
|
"on:shown"?: (e: CustomEvent) => void;
|
|
1122
1163
|
/** */
|
|
@@ -1128,42 +1169,38 @@ export type ModalMainSolidJsProps = {
|
|
|
1128
1169
|
textContent?: string | number;
|
|
1129
1170
|
};
|
|
1130
1171
|
|
|
1131
|
-
export type
|
|
1172
|
+
export type WarpModalFooterProps = {};
|
|
1132
1173
|
|
|
1133
|
-
export type
|
|
1174
|
+
export type WarpModalFooterSolidJsProps = {
|
|
1134
1175
|
/** Set the innerHTML of the element */
|
|
1135
1176
|
innerHTML?: string;
|
|
1136
1177
|
/** Set the textContent of the element */
|
|
1137
1178
|
textContent?: string | number;
|
|
1138
1179
|
};
|
|
1139
1180
|
|
|
1140
|
-
export type
|
|
1141
|
-
/**
|
|
1142
|
-
title?:
|
|
1143
|
-
/**
|
|
1144
|
-
back?:
|
|
1145
|
-
/**
|
|
1146
|
-
"no-close"?:
|
|
1147
|
-
/**
|
|
1148
|
-
noClose?:
|
|
1149
|
-
/** */
|
|
1150
|
-
titleEl?: ModalHeader["titleEl"];
|
|
1181
|
+
export type WarpModalHeaderProps = {
|
|
1182
|
+
/** A short but descriptive title for the modal */
|
|
1183
|
+
title?: WarpModalHeader["title"];
|
|
1184
|
+
/** Whether the modal header should have a back button */
|
|
1185
|
+
back?: WarpModalHeader["back"];
|
|
1186
|
+
/** Lets you hide the close button in the header */
|
|
1187
|
+
"no-close"?: WarpModalHeader["noClose"];
|
|
1188
|
+
/** Lets you hide the close button in the header */
|
|
1189
|
+
noClose?: WarpModalHeader["noClose"];
|
|
1151
1190
|
|
|
1152
1191
|
/** */
|
|
1153
1192
|
onbackClicked?: (e: CustomEvent) => void;
|
|
1154
1193
|
};
|
|
1155
1194
|
|
|
1156
|
-
export type
|
|
1157
|
-
/**
|
|
1158
|
-
"prop:title"?:
|
|
1159
|
-
/**
|
|
1160
|
-
"prop:back"?:
|
|
1161
|
-
/**
|
|
1162
|
-
"bool:no-close"?:
|
|
1163
|
-
/**
|
|
1164
|
-
"prop:noClose"?:
|
|
1165
|
-
/** */
|
|
1166
|
-
"prop:titleEl"?: ModalHeader["titleEl"];
|
|
1195
|
+
export type WarpModalHeaderSolidJsProps = {
|
|
1196
|
+
/** A short but descriptive title for the modal */
|
|
1197
|
+
"prop:title"?: WarpModalHeader["title"];
|
|
1198
|
+
/** Whether the modal header should have a back button */
|
|
1199
|
+
"prop:back"?: WarpModalHeader["back"];
|
|
1200
|
+
/** Lets you hide the close button in the header */
|
|
1201
|
+
"bool:no-close"?: WarpModalHeader["noClose"];
|
|
1202
|
+
/** Lets you hide the close button in the header */
|
|
1203
|
+
"prop:noClose"?: WarpModalHeader["noClose"];
|
|
1167
1204
|
/** */
|
|
1168
1205
|
"on:backClicked"?: (e: CustomEvent) => void;
|
|
1169
1206
|
|
|
@@ -1174,24 +1211,24 @@ export type ModalHeaderSolidJsProps = {
|
|
|
1174
1211
|
};
|
|
1175
1212
|
|
|
1176
1213
|
export type WarpPageIndicatorProps = {
|
|
1177
|
-
/** Currently selected page (1-based index
|
|
1214
|
+
/** Currently selected page (1-based index) */
|
|
1178
1215
|
"selected-page"?: WarpPageIndicator["selectedPage"];
|
|
1179
|
-
/** Currently selected page (1-based index
|
|
1216
|
+
/** Currently selected page (1-based index) */
|
|
1180
1217
|
selectedPage?: WarpPageIndicator["selectedPage"];
|
|
1181
|
-
/** Total number of pages
|
|
1218
|
+
/** Total number of pages */
|
|
1182
1219
|
"page-count"?: WarpPageIndicator["pageCount"];
|
|
1183
|
-
/** Total number of pages
|
|
1220
|
+
/** Total number of pages */
|
|
1184
1221
|
pageCount?: WarpPageIndicator["pageCount"];
|
|
1185
1222
|
};
|
|
1186
1223
|
|
|
1187
1224
|
export type WarpPageIndicatorSolidJsProps = {
|
|
1188
|
-
/** Currently selected page (1-based index
|
|
1225
|
+
/** Currently selected page (1-based index) */
|
|
1189
1226
|
"attr:selected-page"?: WarpPageIndicator["selectedPage"];
|
|
1190
|
-
/** Currently selected page (1-based index
|
|
1227
|
+
/** Currently selected page (1-based index) */
|
|
1191
1228
|
"prop:selectedPage"?: WarpPageIndicator["selectedPage"];
|
|
1192
|
-
/** Total number of pages
|
|
1229
|
+
/** Total number of pages */
|
|
1193
1230
|
"attr:page-count"?: WarpPageIndicator["pageCount"];
|
|
1194
|
-
/** Total number of pages
|
|
1231
|
+
/** Total number of pages */
|
|
1195
1232
|
"prop:pageCount"?: WarpPageIndicator["pageCount"];
|
|
1196
1233
|
|
|
1197
1234
|
/** Set the innerHTML of the element */
|
|
@@ -1201,41 +1238,49 @@ export type WarpPageIndicatorSolidJsProps = {
|
|
|
1201
1238
|
};
|
|
1202
1239
|
|
|
1203
1240
|
export type WarpPaginationProps = {
|
|
1204
|
-
/**
|
|
1241
|
+
/** The base URL used to construct page links, for example `/search?page=`.
|
|
1242
|
+
|
|
1243
|
+
The page number is appended to this URL. */
|
|
1205
1244
|
"base-url"?: WarpPagination["baseUrl"];
|
|
1206
|
-
/**
|
|
1245
|
+
/** The base URL used to construct page links, for example `/search?page=`.
|
|
1246
|
+
|
|
1247
|
+
The page number is appended to this URL. */
|
|
1207
1248
|
baseUrl?: WarpPagination["baseUrl"];
|
|
1208
|
-
/**
|
|
1249
|
+
/** The total number of pages. */
|
|
1209
1250
|
pages?: WarpPagination["pages"];
|
|
1210
|
-
/**
|
|
1251
|
+
/** The currently active page number. */
|
|
1211
1252
|
"current-page"?: WarpPagination["currentPageNumber"];
|
|
1212
|
-
/**
|
|
1253
|
+
/** The currently active page number. */
|
|
1213
1254
|
currentPageNumber?: WarpPagination["currentPageNumber"];
|
|
1214
|
-
/**
|
|
1255
|
+
/** The maximum number of page numbers visible. */
|
|
1215
1256
|
"visible-pages"?: WarpPagination["visiblePages"];
|
|
1216
|
-
/**
|
|
1257
|
+
/** The maximum number of page numbers visible. */
|
|
1217
1258
|
visiblePages?: WarpPagination["visiblePages"];
|
|
1218
1259
|
|
|
1219
|
-
/** Triggered when a link
|
|
1260
|
+
/** Triggered when a link in the pagination is clicked. Contains the page number in `string` form. */
|
|
1220
1261
|
"onpage-click"?: (e: CustomEvent) => void;
|
|
1221
1262
|
};
|
|
1222
1263
|
|
|
1223
1264
|
export type WarpPaginationSolidJsProps = {
|
|
1224
|
-
/**
|
|
1265
|
+
/** The base URL used to construct page links, for example `/search?page=`.
|
|
1266
|
+
|
|
1267
|
+
The page number is appended to this URL. */
|
|
1225
1268
|
"attr:base-url"?: WarpPagination["baseUrl"];
|
|
1226
|
-
/**
|
|
1269
|
+
/** The base URL used to construct page links, for example `/search?page=`.
|
|
1270
|
+
|
|
1271
|
+
The page number is appended to this URL. */
|
|
1227
1272
|
"prop:baseUrl"?: WarpPagination["baseUrl"];
|
|
1228
|
-
/**
|
|
1273
|
+
/** The total number of pages. */
|
|
1229
1274
|
"prop:pages"?: WarpPagination["pages"];
|
|
1230
|
-
/**
|
|
1275
|
+
/** The currently active page number. */
|
|
1231
1276
|
"attr:current-page"?: WarpPagination["currentPageNumber"];
|
|
1232
|
-
/**
|
|
1277
|
+
/** The currently active page number. */
|
|
1233
1278
|
"prop:currentPageNumber"?: WarpPagination["currentPageNumber"];
|
|
1234
|
-
/**
|
|
1279
|
+
/** The maximum number of page numbers visible. */
|
|
1235
1280
|
"attr:visible-pages"?: WarpPagination["visiblePages"];
|
|
1236
|
-
/**
|
|
1281
|
+
/** The maximum number of page numbers visible. */
|
|
1237
1282
|
"prop:visiblePages"?: WarpPagination["visiblePages"];
|
|
1238
|
-
/** Triggered when a link
|
|
1283
|
+
/** Triggered when a link in the pagination is clicked. Contains the page number in `string` form. */
|
|
1239
1284
|
"on:page-click"?: (e: CustomEvent) => void;
|
|
1240
1285
|
|
|
1241
1286
|
/** Set the innerHTML of the element */
|
|
@@ -1245,69 +1290,61 @@ export type WarpPaginationSolidJsProps = {
|
|
|
1245
1290
|
};
|
|
1246
1291
|
|
|
1247
1292
|
export type WarpPillProps = {
|
|
1248
|
-
/**
|
|
1293
|
+
/** Whether the pill should be removable via a close button. */
|
|
1249
1294
|
"can-close"?: WarpPill["canClose"];
|
|
1250
|
-
/**
|
|
1295
|
+
/** Whether the pill should be removable via a close button. */
|
|
1251
1296
|
canClose?: WarpPill["canClose"];
|
|
1252
|
-
/**
|
|
1297
|
+
/** Whether the pill should be rendered as a suggestion. */
|
|
1253
1298
|
suggestion?: WarpPill["suggestion"];
|
|
1254
1299
|
/** @deprecated Used "open-arial-label" instead. */
|
|
1255
1300
|
"open-sr-label"?: WarpPill["openSrLabel"];
|
|
1256
1301
|
/** @deprecated Used "open-arial-label" instead. */
|
|
1257
1302
|
openSrLabel?: WarpPill["openSrLabel"];
|
|
1258
|
-
/**
|
|
1303
|
+
/** Label read by screen readers when targeting the pill. */
|
|
1259
1304
|
"open-aria-label"?: WarpPill["openAriaLabel"];
|
|
1260
|
-
/**
|
|
1305
|
+
/** Label read by screen readers when targeting the pill. */
|
|
1261
1306
|
openAriaLabel?: WarpPill["openAriaLabel"];
|
|
1262
1307
|
/** @deprecated Used "close-arial-label" instead. */
|
|
1263
1308
|
"close-sr-label"?: WarpPill["closeSrLabel"];
|
|
1264
1309
|
/** @deprecated Used "close-arial-label" instead. */
|
|
1265
1310
|
closeSrLabel?: WarpPill["closeSrLabel"];
|
|
1266
|
-
/**
|
|
1311
|
+
/** Label read by screen readers when targeting the close button. */
|
|
1267
1312
|
"close-aria-label"?: WarpPill["closeAriaLabel"];
|
|
1268
|
-
/**
|
|
1313
|
+
/** Label read by screen readers when targeting the close button. */
|
|
1269
1314
|
closeAriaLabel?: WarpPill["closeAriaLabel"];
|
|
1270
|
-
/** */
|
|
1271
|
-
openFilterSrText?: WarpPill["openFilterSrText"];
|
|
1272
|
-
/** */
|
|
1273
|
-
removeFilterSrText?: WarpPill["removeFilterSrText"];
|
|
1274
1315
|
|
|
1275
|
-
/**
|
|
1316
|
+
/** Fires when the pill itself is clicked. */
|
|
1276
1317
|
"onw-pill-click"?: (e: CustomEvent) => void;
|
|
1277
|
-
/**
|
|
1318
|
+
/** Fires when the pill's close button is clicked. */
|
|
1278
1319
|
"onw-pill-close"?: (e: CustomEvent) => void;
|
|
1279
1320
|
};
|
|
1280
1321
|
|
|
1281
1322
|
export type WarpPillSolidJsProps = {
|
|
1282
|
-
/**
|
|
1323
|
+
/** Whether the pill should be removable via a close button. */
|
|
1283
1324
|
"bool:can-close"?: WarpPill["canClose"];
|
|
1284
|
-
/**
|
|
1325
|
+
/** Whether the pill should be removable via a close button. */
|
|
1285
1326
|
"prop:canClose"?: WarpPill["canClose"];
|
|
1286
|
-
/**
|
|
1327
|
+
/** Whether the pill should be rendered as a suggestion. */
|
|
1287
1328
|
"prop:suggestion"?: WarpPill["suggestion"];
|
|
1288
1329
|
/** @deprecated Used "open-arial-label" instead. */
|
|
1289
1330
|
"attr:open-sr-label"?: WarpPill["openSrLabel"];
|
|
1290
1331
|
/** @deprecated Used "open-arial-label" instead. */
|
|
1291
1332
|
"prop:openSrLabel"?: WarpPill["openSrLabel"];
|
|
1292
|
-
/**
|
|
1333
|
+
/** Label read by screen readers when targeting the pill. */
|
|
1293
1334
|
"attr:open-aria-label"?: WarpPill["openAriaLabel"];
|
|
1294
|
-
/**
|
|
1335
|
+
/** Label read by screen readers when targeting the pill. */
|
|
1295
1336
|
"prop:openAriaLabel"?: WarpPill["openAriaLabel"];
|
|
1296
1337
|
/** @deprecated Used "close-arial-label" instead. */
|
|
1297
1338
|
"attr:close-sr-label"?: WarpPill["closeSrLabel"];
|
|
1298
1339
|
/** @deprecated Used "close-arial-label" instead. */
|
|
1299
1340
|
"prop:closeSrLabel"?: WarpPill["closeSrLabel"];
|
|
1300
|
-
/**
|
|
1341
|
+
/** Label read by screen readers when targeting the close button. */
|
|
1301
1342
|
"attr:close-aria-label"?: WarpPill["closeAriaLabel"];
|
|
1302
|
-
/**
|
|
1343
|
+
/** Label read by screen readers when targeting the close button. */
|
|
1303
1344
|
"prop:closeAriaLabel"?: WarpPill["closeAriaLabel"];
|
|
1304
|
-
/**
|
|
1305
|
-
"prop:openFilterSrText"?: WarpPill["openFilterSrText"];
|
|
1306
|
-
/** */
|
|
1307
|
-
"prop:removeFilterSrText"?: WarpPill["removeFilterSrText"];
|
|
1308
|
-
/** */
|
|
1345
|
+
/** Fires when the pill itself is clicked. */
|
|
1309
1346
|
"on:w-pill-click"?: (e: CustomEvent) => void;
|
|
1310
|
-
/**
|
|
1347
|
+
/** Fires when the pill's close button is clicked. */
|
|
1311
1348
|
"on:w-pill-close"?: (e: CustomEvent) => void;
|
|
1312
1349
|
|
|
1313
1350
|
/** Set the innerHTML of the element */
|
|
@@ -1316,46 +1353,34 @@ export type WarpPillSolidJsProps = {
|
|
|
1316
1353
|
textContent?: string | number;
|
|
1317
1354
|
};
|
|
1318
1355
|
|
|
1319
|
-
export type
|
|
1356
|
+
export type WarpRadioProps = {
|
|
1320
1357
|
/** The name of the radio, submitted as a name/value pair with form data. */
|
|
1321
|
-
name?:
|
|
1358
|
+
name?: WarpRadio["name"];
|
|
1322
1359
|
/** The radio's value. When selected, the radio group will receive this value. */
|
|
1323
|
-
value?:
|
|
1360
|
+
value?: WarpRadio["value"];
|
|
1324
1361
|
/** Draws the radio in a checked state (reflected to attribute). */
|
|
1325
|
-
checked?:
|
|
1362
|
+
checked?: WarpRadio["checked"];
|
|
1326
1363
|
/** Disables the radio. */
|
|
1327
|
-
disabled?:
|
|
1364
|
+
disabled?: WarpRadio["disabled"];
|
|
1328
1365
|
/** Makes the radio a required field. */
|
|
1329
|
-
required?:
|
|
1366
|
+
required?: WarpRadio["required"];
|
|
1330
1367
|
/** Draws the radio in an invalid state. */
|
|
1331
|
-
invalid?:
|
|
1332
|
-
/** Override tabIndex setter to set _groupTabIndex (for backwards compatibility).
|
|
1333
|
-
Radio-group should use _groupTabIndex directly for clarity. */
|
|
1334
|
-
tabIndex?: WRadio["tabIndex"];
|
|
1335
|
-
/** Internal tabindex for standalone radios (not in a group).
|
|
1336
|
-
Non-reflecting to avoid DOM changes during hydration. */
|
|
1337
|
-
_standaloneTabIndex?: WRadio["_standaloneTabIndex"];
|
|
1368
|
+
invalid?: WarpRadio["invalid"];
|
|
1338
1369
|
};
|
|
1339
1370
|
|
|
1340
|
-
export type
|
|
1371
|
+
export type WarpRadioSolidJsProps = {
|
|
1341
1372
|
/** The name of the radio, submitted as a name/value pair with form data. */
|
|
1342
|
-
"prop:name"?:
|
|
1373
|
+
"prop:name"?: WarpRadio["name"];
|
|
1343
1374
|
/** The radio's value. When selected, the radio group will receive this value. */
|
|
1344
|
-
"prop:value"?:
|
|
1375
|
+
"prop:value"?: WarpRadio["value"];
|
|
1345
1376
|
/** Draws the radio in a checked state (reflected to attribute). */
|
|
1346
|
-
"prop:checked"?:
|
|
1377
|
+
"prop:checked"?: WarpRadio["checked"];
|
|
1347
1378
|
/** Disables the radio. */
|
|
1348
|
-
"prop:disabled"?:
|
|
1379
|
+
"prop:disabled"?: WarpRadio["disabled"];
|
|
1349
1380
|
/** Makes the radio a required field. */
|
|
1350
|
-
"prop:required"?:
|
|
1381
|
+
"prop:required"?: WarpRadio["required"];
|
|
1351
1382
|
/** Draws the radio in an invalid state. */
|
|
1352
|
-
"prop:invalid"?:
|
|
1353
|
-
/** Override tabIndex setter to set _groupTabIndex (for backwards compatibility).
|
|
1354
|
-
Radio-group should use _groupTabIndex directly for clarity. */
|
|
1355
|
-
"prop:tabIndex"?: WRadio["tabIndex"];
|
|
1356
|
-
/** Internal tabindex for standalone radios (not in a group).
|
|
1357
|
-
Non-reflecting to avoid DOM changes during hydration. */
|
|
1358
|
-
"prop:_standaloneTabIndex"?: WRadio["_standaloneTabIndex"];
|
|
1383
|
+
"prop:invalid"?: WarpRadio["invalid"];
|
|
1359
1384
|
|
|
1360
1385
|
/** Set the innerHTML of the element */
|
|
1361
1386
|
innerHTML?: string;
|
|
@@ -1363,46 +1388,50 @@ Non-reflecting to avoid DOM changes during hydration. */
|
|
|
1363
1388
|
textContent?: string | number;
|
|
1364
1389
|
};
|
|
1365
1390
|
|
|
1366
|
-
export type
|
|
1367
|
-
/**
|
|
1368
|
-
label?:
|
|
1369
|
-
/**
|
|
1370
|
-
"help-text"?: WRadioGroup["helpText"];
|
|
1371
|
-
/** */
|
|
1372
|
-
helpText?: WRadioGroup["helpText"];
|
|
1373
|
-
/** */
|
|
1374
|
-
optional?: WRadioGroup["optional"];
|
|
1375
|
-
/** */
|
|
1376
|
-
invalid?: WRadioGroup["invalid"];
|
|
1377
|
-
/** */
|
|
1378
|
-
name?: WRadioGroup["name"];
|
|
1379
|
-
/** */
|
|
1380
|
-
disabled?: WRadioGroup["disabled"];
|
|
1381
|
-
/** */
|
|
1382
|
-
required?: WRadioGroup["required"];
|
|
1383
|
-
/** */
|
|
1384
|
-
hasInteracted?: WRadioGroup["hasInteracted"];
|
|
1385
|
-
};
|
|
1391
|
+
export type WarpRadioGroupProps = {
|
|
1392
|
+
/** Label for the radio group. */
|
|
1393
|
+
label?: WarpRadioGroup["label"];
|
|
1394
|
+
/** Help text for the radio group.
|
|
1386
1395
|
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
|
|
1396
|
+
If you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute. */
|
|
1397
|
+
"help-text"?: WarpRadioGroup["helpText"];
|
|
1398
|
+
/** Help text for the radio group.
|
|
1399
|
+
|
|
1400
|
+
If you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute. */
|
|
1401
|
+
helpText?: WarpRadioGroup["helpText"];
|
|
1402
|
+
/** Whether to show optional text next to the label. */
|
|
1403
|
+
optional?: WarpRadioGroup["optional"];
|
|
1404
|
+
/** Marks the radio group as invalid. */
|
|
1405
|
+
invalid?: WarpRadioGroup["invalid"];
|
|
1406
|
+
/** The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form. */
|
|
1407
|
+
name?: WarpRadioGroup["name"];
|
|
1408
|
+
/** Disables the radio group and all child radios. */
|
|
1409
|
+
disabled?: WarpRadioGroup["disabled"];
|
|
1410
|
+
/** Makes selecting a radio in the the group required. */
|
|
1411
|
+
required?: WarpRadioGroup["required"];
|
|
1412
|
+
};
|
|
1413
|
+
|
|
1414
|
+
export type WarpRadioGroupSolidJsProps = {
|
|
1415
|
+
/** Label for the radio group. */
|
|
1416
|
+
"prop:label"?: WarpRadioGroup["label"];
|
|
1417
|
+
/** Help text for the radio group.
|
|
1418
|
+
|
|
1419
|
+
If you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute. */
|
|
1420
|
+
"attr:help-text"?: WarpRadioGroup["helpText"];
|
|
1421
|
+
/** Help text for the radio group.
|
|
1422
|
+
|
|
1423
|
+
If you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute. */
|
|
1424
|
+
"prop:helpText"?: WarpRadioGroup["helpText"];
|
|
1425
|
+
/** Whether to show optional text next to the label. */
|
|
1426
|
+
"prop:optional"?: WarpRadioGroup["optional"];
|
|
1427
|
+
/** Marks the radio group as invalid. */
|
|
1428
|
+
"prop:invalid"?: WarpRadioGroup["invalid"];
|
|
1429
|
+
/** The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form. */
|
|
1430
|
+
"prop:name"?: WarpRadioGroup["name"];
|
|
1431
|
+
/** Disables the radio group and all child radios. */
|
|
1432
|
+
"prop:disabled"?: WarpRadioGroup["disabled"];
|
|
1433
|
+
/** Makes selecting a radio in the the group required. */
|
|
1434
|
+
"prop:required"?: WarpRadioGroup["required"];
|
|
1406
1435
|
|
|
1407
1436
|
/** Set the innerHTML of the element */
|
|
1408
1437
|
innerHTML?: string;
|
|
@@ -1417,19 +1446,25 @@ export type WarpSelectProps = {
|
|
|
1417
1446
|
autoFocus?: WarpSelect["autoFocus"];
|
|
1418
1447
|
/** Whether the element should receive focus on render */
|
|
1419
1448
|
autofocus?: WarpSelect["autofocus"];
|
|
1420
|
-
/** The content displayed as the help text.
|
|
1449
|
+
/** The content displayed as the help text.
|
|
1450
|
+
|
|
1451
|
+
Paired with `invalid` to show the text as a validation error. */
|
|
1421
1452
|
"help-text"?: WarpSelect["helpText"];
|
|
1422
|
-
/** The content displayed as the help text.
|
|
1453
|
+
/** The content displayed as the help text.
|
|
1454
|
+
|
|
1455
|
+
Paired with `invalid` to show the text as a validation error. */
|
|
1423
1456
|
helpText?: WarpSelect["helpText"];
|
|
1424
|
-
/** Renders the field in an invalid state.
|
|
1457
|
+
/** Renders the field in an invalid state.
|
|
1458
|
+
|
|
1459
|
+
Paired with `help-text` to provide feedback about the error. */
|
|
1425
1460
|
invalid?: WarpSelect["invalid"];
|
|
1426
1461
|
/** @deprecated Use `help-text` instead and only set it if you want to display the help text. - Whether to always show a hint. */
|
|
1427
1462
|
always?: WarpSelect["always"];
|
|
1428
1463
|
/** @deprecated Use `help-text` instead. - The content displayed as the help text. */
|
|
1429
1464
|
hint?: WarpSelect["hint"];
|
|
1430
|
-
/** The content to
|
|
1465
|
+
/** The content to display as the label. */
|
|
1431
1466
|
label?: WarpSelect["label"];
|
|
1432
|
-
/** Whether to show optional
|
|
1467
|
+
/** Whether to show the optional indicator after the label. */
|
|
1433
1468
|
optional?: WarpSelect["optional"];
|
|
1434
1469
|
/** Renders the field in a disabled state. */
|
|
1435
1470
|
disabled?: WarpSelect["disabled"];
|
|
@@ -1439,9 +1474,9 @@ export type WarpSelectProps = {
|
|
|
1439
1474
|
readOnly?: WarpSelect["readOnly"];
|
|
1440
1475
|
/** Renders the field in a readonly state. */
|
|
1441
1476
|
readonly?: WarpSelect["readonly"];
|
|
1442
|
-
/**
|
|
1477
|
+
/** The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form. */
|
|
1443
1478
|
name?: WarpSelect["name"];
|
|
1444
|
-
/**
|
|
1479
|
+
/** Lets you set the current value. */
|
|
1445
1480
|
value?: WarpSelect["value"];
|
|
1446
1481
|
|
|
1447
1482
|
/** */
|
|
@@ -1455,19 +1490,25 @@ export type WarpSelectSolidJsProps = {
|
|
|
1455
1490
|
"prop:autoFocus"?: WarpSelect["autoFocus"];
|
|
1456
1491
|
/** Whether the element should receive focus on render */
|
|
1457
1492
|
"prop:autofocus"?: WarpSelect["autofocus"];
|
|
1458
|
-
/** The content displayed as the help text.
|
|
1493
|
+
/** The content displayed as the help text.
|
|
1494
|
+
|
|
1495
|
+
Paired with `invalid` to show the text as a validation error. */
|
|
1459
1496
|
"attr:help-text"?: WarpSelect["helpText"];
|
|
1460
|
-
/** The content displayed as the help text.
|
|
1497
|
+
/** The content displayed as the help text.
|
|
1498
|
+
|
|
1499
|
+
Paired with `invalid` to show the text as a validation error. */
|
|
1461
1500
|
"prop:helpText"?: WarpSelect["helpText"];
|
|
1462
|
-
/** Renders the field in an invalid state.
|
|
1501
|
+
/** Renders the field in an invalid state.
|
|
1502
|
+
|
|
1503
|
+
Paired with `help-text` to provide feedback about the error. */
|
|
1463
1504
|
"prop:invalid"?: WarpSelect["invalid"];
|
|
1464
1505
|
/** @deprecated Use `help-text` instead and only set it if you want to display the help text. - Whether to always show a hint. */
|
|
1465
1506
|
"prop:always"?: WarpSelect["always"];
|
|
1466
1507
|
/** @deprecated Use `help-text` instead. - The content displayed as the help text. */
|
|
1467
1508
|
"prop:hint"?: WarpSelect["hint"];
|
|
1468
|
-
/** The content to
|
|
1509
|
+
/** The content to display as the label. */
|
|
1469
1510
|
"prop:label"?: WarpSelect["label"];
|
|
1470
|
-
/** Whether to show optional
|
|
1511
|
+
/** Whether to show the optional indicator after the label. */
|
|
1471
1512
|
"prop:optional"?: WarpSelect["optional"];
|
|
1472
1513
|
/** Renders the field in a disabled state. */
|
|
1473
1514
|
"prop:disabled"?: WarpSelect["disabled"];
|
|
@@ -1477,9 +1518,9 @@ export type WarpSelectSolidJsProps = {
|
|
|
1477
1518
|
"prop:readOnly"?: WarpSelect["readOnly"];
|
|
1478
1519
|
/** Renders the field in a readonly state. */
|
|
1479
1520
|
"prop:readonly"?: WarpSelect["readonly"];
|
|
1480
|
-
/**
|
|
1521
|
+
/** The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form. */
|
|
1481
1522
|
"prop:name"?: WarpSelect["name"];
|
|
1482
|
-
/**
|
|
1523
|
+
/** Lets you set the current value. */
|
|
1483
1524
|
"prop:value"?: WarpSelect["value"];
|
|
1484
1525
|
/** */
|
|
1485
1526
|
"on:change"?: (e: CustomEvent) => void;
|
|
@@ -2003,7 +2044,8 @@ export type CustomElements = {
|
|
|
2003
2044
|
"w-link": Partial<WarpLinkProps & BaseProps<WarpLink> & BaseEvents>;
|
|
2004
2045
|
|
|
2005
2046
|
/**
|
|
2006
|
-
*
|
|
2047
|
+
* Performs an action or renders a link with button styling.
|
|
2048
|
+
* Use button variants to match action priority, risk, and context.
|
|
2007
2049
|
*
|
|
2008
2050
|
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/buttons-button--docs)
|
|
2009
2051
|
*
|
|
@@ -2011,22 +2053,38 @@ export type CustomElements = {
|
|
|
2011
2053
|
*
|
|
2012
2054
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2013
2055
|
*
|
|
2014
|
-
* - `type`:
|
|
2015
|
-
*
|
|
2016
|
-
* - `
|
|
2017
|
-
*
|
|
2018
|
-
* - `
|
|
2019
|
-
*
|
|
2020
|
-
* - `
|
|
2021
|
-
*
|
|
2022
|
-
* - `
|
|
2023
|
-
*
|
|
2024
|
-
* - `
|
|
2025
|
-
*
|
|
2026
|
-
* - `
|
|
2027
|
-
*
|
|
2028
|
-
* - `
|
|
2029
|
-
*
|
|
2056
|
+
* - `type`: Native button type.
|
|
2057
|
+
* Controls whether the internal button behaves as a regular button, submits a form, or resets a form. Defaults to `button`.
|
|
2058
|
+
* - `autofocus`: Focuses the button when it is first rendered.
|
|
2059
|
+
* Applies only when the component renders a native button. Link buttons with `href` do not autofocus through this component.
|
|
2060
|
+
* - `variant`: Visual style of the button.
|
|
2061
|
+
* Defaults to `secondary`. Use the variant that matches the action priority, risk, and placement.
|
|
2062
|
+
* - `quiet`: Deprecated quiet visual treatment flag
|
|
2063
|
+
* Use `variant="quiet"` instead.
|
|
2064
|
+
* - `icon-only`/`iconOnly`: Marks the button as icon-only.
|
|
2065
|
+
* Use this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name.
|
|
2066
|
+
* - `small`: Renders the compact button size.
|
|
2067
|
+
* Use this in dense layouts where the default button size is too large.
|
|
2068
|
+
* - `loading`: Shows the loading state.
|
|
2069
|
+
* Use after the user has triggered an action and the action is in progress.
|
|
2070
|
+
* - `href`: URL for rendering the button as a link.
|
|
2071
|
+
* When set, the component renders `w-link` instead of a native `button`.
|
|
2072
|
+
* - `target`: Link browsing context.
|
|
2073
|
+
* Passed to the rendered link when `href` is set.
|
|
2074
|
+
* - `disabled`: Visually disables the button.
|
|
2075
|
+
* Disabled buttons are discouraged because they can hide the reason an action is unavailable.
|
|
2076
|
+
* - `rel`: Link relationship.
|
|
2077
|
+
* Passed to the rendered link when `href` is set. If `target="_blank"` is set and `rel` is omitted, `noopener` is used.
|
|
2078
|
+
* - `full-width`/`fullWidth`: Makes the button fill its parent width.
|
|
2079
|
+
* Useful in narrow layouts where the button should span the available inline space.
|
|
2080
|
+
* - `button-class`/`buttonClass`: Deprecated class applied to the internal control
|
|
2081
|
+
* This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance.
|
|
2082
|
+
* - `name`: Form control name.
|
|
2083
|
+
* Used when the button participates in form handling.
|
|
2084
|
+
* - `value`: Form control value.
|
|
2085
|
+
* Used with `name` when the button participates in form handling. Resets to its initial value when the form is reset.
|
|
2086
|
+
* - `commandfor`: The [commandfor HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.
|
|
2087
|
+
* - `command`: The [command HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.
|
|
2030
2088
|
*
|
|
2031
2089
|
* ## Methods
|
|
2032
2090
|
*
|
|
@@ -2361,18 +2419,15 @@ export type CustomElements = {
|
|
|
2361
2419
|
/**
|
|
2362
2420
|
* Modals (or dialogs) display important information that users need to acknowledge.
|
|
2363
2421
|
*
|
|
2364
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
2365
|
-
*
|
|
2366
2422
|
* ## Attributes & Properties
|
|
2367
2423
|
*
|
|
2368
2424
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2369
2425
|
*
|
|
2370
|
-
* - `show`:
|
|
2426
|
+
* - `show`: Controls if the modal should show or hide.
|
|
2427
|
+
*
|
|
2428
|
+
* You can also call the `open()` and `close()` methods.
|
|
2371
2429
|
* - `content-id`/`contentId`: undefined
|
|
2372
|
-
* - `ignore-backdrop-clicks`/`ignoreBackdropClicks`:
|
|
2373
|
-
* - `dialogEl`: undefined (property only)
|
|
2374
|
-
* - `dialogInnerEl`: undefined (property only)
|
|
2375
|
-
* - `contentEl`: undefined (property only)
|
|
2430
|
+
* - `ignore-backdrop-clicks`/`ignoreBackdropClicks`: Ignores clicks to the backdrop when set
|
|
2376
2431
|
*
|
|
2377
2432
|
* ## Events
|
|
2378
2433
|
*
|
|
@@ -2395,39 +2450,26 @@ export type CustomElements = {
|
|
|
2395
2450
|
*
|
|
2396
2451
|
* - `open() => void`: undefined
|
|
2397
2452
|
* - `close() => void`: undefined
|
|
2398
|
-
* - `handleListeners(verb = 'addEventListener') => void`: undefined
|
|
2399
|
-
* - `eventPreventer(evt: Event) => void`: undefined
|
|
2400
|
-
* - `closeOnBackdropClick(evt: MouseEvent) => void`: undefined
|
|
2401
|
-
* - `interceptEscape(evt: KeyboardEvent) => void`: undefined
|
|
2402
|
-
* - `modifyBorderRadius() => void`: undefined
|
|
2403
2453
|
*/
|
|
2404
|
-
"w-modal": Partial<
|
|
2454
|
+
"w-modal": Partial<WarpModalProps & BaseProps<WarpModal> & BaseEvents>;
|
|
2405
2455
|
|
|
2406
2456
|
/**
|
|
2407
2457
|
* The footer section of a modal, typically where you place actions.
|
|
2408
|
-
*
|
|
2409
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
2410
2458
|
*/
|
|
2411
2459
|
"w-modal-footer": Partial<
|
|
2412
|
-
|
|
2460
|
+
WarpModalFooterProps & BaseProps<WarpModalFooter> & BaseEvents
|
|
2413
2461
|
>;
|
|
2414
2462
|
|
|
2415
2463
|
/**
|
|
2416
2464
|
* The header section of a modal, typically where you place the title and a close button.
|
|
2417
2465
|
*
|
|
2418
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
2419
|
-
*
|
|
2420
2466
|
* ## Attributes & Properties
|
|
2421
2467
|
*
|
|
2422
2468
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2423
2469
|
*
|
|
2424
|
-
* - `title`:
|
|
2425
|
-
* - `back`:
|
|
2426
|
-
* - `no-close`/`noClose`:
|
|
2427
|
-
* - `titleEl`: undefined (property only)
|
|
2428
|
-
* - `titleClasses`: undefined (property only) (readonly)
|
|
2429
|
-
* - `backButton`: undefined (property only) (readonly)
|
|
2430
|
-
* - `closeButton`: undefined (property only) (readonly)
|
|
2470
|
+
* - `title`: A short but descriptive title for the modal
|
|
2471
|
+
* - `back`: Whether the modal header should have a back button
|
|
2472
|
+
* - `no-close`/`noClose`: Lets you hide the close button in the header
|
|
2431
2473
|
*
|
|
2432
2474
|
* ## Events
|
|
2433
2475
|
*
|
|
@@ -2440,28 +2482,22 @@ export type CustomElements = {
|
|
|
2440
2482
|
* Areas where markup can be added to the component.
|
|
2441
2483
|
*
|
|
2442
2484
|
* - `top`: Customize the title bar, for example to have a header image that reaches the modal's edges. See the With Image story for an example.
|
|
2443
|
-
*
|
|
2444
|
-
* ## Methods
|
|
2445
|
-
*
|
|
2446
|
-
* Methods that can be called to access component functionality.
|
|
2447
|
-
*
|
|
2448
|
-
* - `emitBack() => void`: undefined
|
|
2449
|
-
* - `handleTopSlotChange(slotEvent) => void`: undefined
|
|
2450
2485
|
*/
|
|
2451
2486
|
"w-modal-header": Partial<
|
|
2452
|
-
|
|
2487
|
+
WarpModalHeaderProps & BaseProps<WarpModalHeader> & BaseEvents
|
|
2453
2488
|
>;
|
|
2454
2489
|
|
|
2455
2490
|
/**
|
|
2456
2491
|
* A page indicator component that displays a series of dots representing pages.
|
|
2492
|
+
*
|
|
2457
2493
|
* One dot is highlighted to indicate the currently selected page.
|
|
2458
2494
|
*
|
|
2459
2495
|
* ## Attributes & Properties
|
|
2460
2496
|
*
|
|
2461
2497
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2462
2498
|
*
|
|
2463
|
-
* - `selected-page`/`selectedPage`: Currently selected page (1-based index
|
|
2464
|
-
* - `page-count`/`pageCount`: Total number of pages
|
|
2499
|
+
* - `selected-page`/`selectedPage`: Currently selected page (1-based index)
|
|
2500
|
+
* - `page-count`/`pageCount`: Total number of pages
|
|
2465
2501
|
*/
|
|
2466
2502
|
"w-page-indicator": Partial<
|
|
2467
2503
|
WarpPageIndicatorProps & BaseProps<WarpPageIndicator> & BaseEvents
|
|
@@ -2470,22 +2506,22 @@ export type CustomElements = {
|
|
|
2470
2506
|
/**
|
|
2471
2507
|
* Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.
|
|
2472
2508
|
*
|
|
2473
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/navigation-pagination--docs)
|
|
2474
|
-
*
|
|
2475
2509
|
* ## Attributes & Properties
|
|
2476
2510
|
*
|
|
2477
2511
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2478
2512
|
*
|
|
2479
|
-
* - `base-url`/`baseUrl`:
|
|
2480
|
-
*
|
|
2481
|
-
*
|
|
2482
|
-
* - `
|
|
2513
|
+
* - `base-url`/`baseUrl`: The base URL used to construct page links, for example `/search?page=`.
|
|
2514
|
+
*
|
|
2515
|
+
* The page number is appended to this URL.
|
|
2516
|
+
* - `pages`: The total number of pages.
|
|
2517
|
+
* - `current-page`/`currentPageNumber`: The currently active page number.
|
|
2518
|
+
* - `visible-pages`/`visiblePages`: The maximum number of page numbers visible.
|
|
2483
2519
|
*
|
|
2484
2520
|
* ## Events
|
|
2485
2521
|
*
|
|
2486
2522
|
* Events that will be emitted by the component.
|
|
2487
2523
|
*
|
|
2488
|
-
* - `page-click`: Triggered when a link
|
|
2524
|
+
* - `page-click`: Triggered when a link in the pagination is clicked. Contains the page number in `string` form.
|
|
2489
2525
|
*/
|
|
2490
2526
|
"w-pagination": Partial<
|
|
2491
2527
|
WarpPaginationProps & BaseProps<WarpPagination> & BaseEvents
|
|
@@ -2494,27 +2530,23 @@ export type CustomElements = {
|
|
|
2494
2530
|
/**
|
|
2495
2531
|
* Pill is a type of button that is often used as a filter, but can also be used as a rounded button for overlays, etc.
|
|
2496
2532
|
*
|
|
2497
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/buttons-pill--docs)
|
|
2498
|
-
*
|
|
2499
2533
|
* ## Attributes & Properties
|
|
2500
2534
|
*
|
|
2501
2535
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2502
2536
|
*
|
|
2503
|
-
* - `can-close`/`canClose`:
|
|
2504
|
-
* - `suggestion`:
|
|
2537
|
+
* - `can-close`/`canClose`: Whether the pill should be removable via a close button.
|
|
2538
|
+
* - `suggestion`: Whether the pill should be rendered as a suggestion.
|
|
2505
2539
|
* - `open-sr-label`/`openSrLabel`: undefined
|
|
2506
|
-
* - `open-aria-label`/`openAriaLabel`:
|
|
2540
|
+
* - `open-aria-label`/`openAriaLabel`: Label read by screen readers when targeting the pill.
|
|
2507
2541
|
* - `close-sr-label`/`closeSrLabel`: undefined
|
|
2508
|
-
* - `close-aria-label`/`closeAriaLabel`:
|
|
2509
|
-
* - `openFilterSrText`: undefined (property only)
|
|
2510
|
-
* - `removeFilterSrText`: undefined (property only)
|
|
2542
|
+
* - `close-aria-label`/`closeAriaLabel`: Label read by screen readers when targeting the close button.
|
|
2511
2543
|
*
|
|
2512
2544
|
* ## Events
|
|
2513
2545
|
*
|
|
2514
2546
|
* Events that will be emitted by the component.
|
|
2515
2547
|
*
|
|
2516
|
-
* - `w-pill-click`:
|
|
2517
|
-
* - `w-pill-close`:
|
|
2548
|
+
* - `w-pill-click`: Fires when the pill itself is clicked.
|
|
2549
|
+
* - `w-pill-close`: Fires when the pill's close button is clicked.
|
|
2518
2550
|
*/
|
|
2519
2551
|
"w-pill": Partial<WarpPillProps & BaseProps<WarpPill> & BaseEvents>;
|
|
2520
2552
|
|
|
@@ -2531,39 +2563,27 @@ export type CustomElements = {
|
|
|
2531
2563
|
* - `disabled`: Disables the radio.
|
|
2532
2564
|
* - `required`: Makes the radio a required field.
|
|
2533
2565
|
* - `invalid`: Draws the radio in an invalid state.
|
|
2534
|
-
* - `tabIndex`: Override tabIndex setter to set _groupTabIndex (for backwards compatibility).
|
|
2535
|
-
* Radio-group should use _groupTabIndex directly for clarity. (property only)
|
|
2536
|
-
* - `validationMessage`: Returns the validation message if the radio is invalid, otherwise an empty string (property only) (readonly)
|
|
2537
|
-
* - `validity`: Returns the validity state of the radio (property only) (readonly)
|
|
2538
|
-
* - `_standaloneTabIndex`: Internal tabindex for standalone radios (not in a group).
|
|
2539
|
-
* Non-reflecting to avoid DOM changes during hydration. (property only)
|
|
2540
|
-
*
|
|
2541
|
-
* ## Methods
|
|
2542
|
-
*
|
|
2543
|
-
* Methods that can be called to access component functionality.
|
|
2544
|
-
*
|
|
2545
|
-
* - `resetFormControl() => void`: undefined
|
|
2546
|
-
* - `checkValidity() => boolean`: Checks whether the radio passes constraint validation
|
|
2547
|
-
* - `reportValidity() => boolean`: Checks validity and shows the browser's validation message if invalid
|
|
2548
2566
|
*/
|
|
2549
|
-
"w-radio": Partial<
|
|
2567
|
+
"w-radio": Partial<WarpRadioProps & BaseProps<WarpRadio> & BaseEvents>;
|
|
2550
2568
|
|
|
2551
2569
|
/**
|
|
2570
|
+
* Radios allow users to select a single option from a list of choices.
|
|
2552
2571
|
*
|
|
2572
|
+
* Use with `w-radio`.
|
|
2553
2573
|
*
|
|
2554
2574
|
* ## Attributes & Properties
|
|
2555
2575
|
*
|
|
2556
2576
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2557
2577
|
*
|
|
2558
|
-
* - `label`:
|
|
2559
|
-
* - `help-text`/`helpText`:
|
|
2560
|
-
*
|
|
2561
|
-
*
|
|
2562
|
-
* - `
|
|
2563
|
-
* - `
|
|
2564
|
-
* - `
|
|
2565
|
-
* - `
|
|
2566
|
-
* - `
|
|
2578
|
+
* - `label`: Label for the radio group.
|
|
2579
|
+
* - `help-text`/`helpText`: Help text for the radio group.
|
|
2580
|
+
*
|
|
2581
|
+
* If you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute.
|
|
2582
|
+
* - `optional`: Whether to show optional text next to the label.
|
|
2583
|
+
* - `invalid`: Marks the radio group as invalid.
|
|
2584
|
+
* - `name`: The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.
|
|
2585
|
+
* - `disabled`: Disables the radio group and all child radios.
|
|
2586
|
+
* - `required`: Makes selecting a radio in the the group required.
|
|
2567
2587
|
*
|
|
2568
2588
|
* ## Slots
|
|
2569
2589
|
*
|
|
@@ -2571,57 +2591,41 @@ export type CustomElements = {
|
|
|
2571
2591
|
*
|
|
2572
2592
|
* - `label`: Alternative to the `label` attribute should you need custom HTML.
|
|
2573
2593
|
* - `help-text`: Alternative to the `help-text` attribute should you need custom HTML.
|
|
2574
|
-
*
|
|
2575
|
-
* ## Methods
|
|
2576
|
-
*
|
|
2577
|
-
* Methods that can be called to access component functionality.
|
|
2578
|
-
*
|
|
2579
|
-
* - `resetFormControl() => void`: undefined
|
|
2580
|
-
* - `focus(options?: FocusOptions) => void`: undefined
|
|
2581
|
-
* - `checkValidity() => void`: undefined
|
|
2582
|
-
* - `reportValidity() => void`: undefined
|
|
2583
2594
|
*/
|
|
2584
2595
|
"w-radio-group": Partial<
|
|
2585
|
-
|
|
2596
|
+
WarpRadioGroupProps & BaseProps<WarpRadioGroup> & BaseEvents
|
|
2586
2597
|
>;
|
|
2587
2598
|
|
|
2588
2599
|
/**
|
|
2589
2600
|
* A dropdown component for selecting a single value.
|
|
2590
2601
|
*
|
|
2591
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/forms-select--docs)
|
|
2592
|
-
*
|
|
2593
2602
|
* ## Attributes & Properties
|
|
2594
2603
|
*
|
|
2595
2604
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2596
2605
|
*
|
|
2597
2606
|
* - `auto-focus`/`autoFocus`: Whether the element should receive focus on render.
|
|
2598
2607
|
* - `autofocus`: Whether the element should receive focus on render
|
|
2599
|
-
* - `help-text`/`helpText`: The content displayed as the help text.
|
|
2600
|
-
*
|
|
2608
|
+
* - `help-text`/`helpText`: The content displayed as the help text.
|
|
2609
|
+
*
|
|
2610
|
+
* Paired with `invalid` to show the text as a validation error.
|
|
2611
|
+
* - `invalid`: Renders the field in an invalid state.
|
|
2612
|
+
*
|
|
2613
|
+
* Paired with `help-text` to provide feedback about the error.
|
|
2601
2614
|
* - `always`: Whether to always show a hint.
|
|
2602
2615
|
* - `hint`: The content displayed as the help text.
|
|
2603
|
-
* - `label`: The content to
|
|
2604
|
-
* - `optional`: Whether to show optional
|
|
2616
|
+
* - `label`: The content to display as the label.
|
|
2617
|
+
* - `optional`: Whether to show the optional indicator after the label.
|
|
2605
2618
|
* - `disabled`: Renders the field in a disabled state.
|
|
2606
2619
|
* - `read-only`/`readOnly`: Renders the field in a readonly state.
|
|
2607
2620
|
* - `readonly`: Renders the field in a readonly state.
|
|
2608
|
-
* - `name`:
|
|
2609
|
-
* - `value`:
|
|
2621
|
+
* - `name`: The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.
|
|
2622
|
+
* - `value`: Lets you set the current value.
|
|
2610
2623
|
*
|
|
2611
2624
|
* ## Events
|
|
2612
2625
|
*
|
|
2613
2626
|
* Events that will be emitted by the component.
|
|
2614
2627
|
*
|
|
2615
2628
|
* - `change`: undefined
|
|
2616
|
-
*
|
|
2617
|
-
* ## Methods
|
|
2618
|
-
*
|
|
2619
|
-
* Methods that can be called to access component functionality.
|
|
2620
|
-
*
|
|
2621
|
-
* - `resetFormControl() => void`: undefined
|
|
2622
|
-
* - `formStateRestoreCallback(state: string | File | FormData | null, _reason: 'autocomplete' | 'restore') => void`: undefined
|
|
2623
|
-
* - `handleKeyDown(event: KeyboardEvent) => void`: undefined
|
|
2624
|
-
* - `onChange(event: Event) => void`: undefined
|
|
2625
2629
|
*/
|
|
2626
2630
|
"w-select": Partial<WarpSelectProps & BaseProps<WarpSelect> & BaseEvents>;
|
|
2627
2631
|
|
|
@@ -3003,7 +3007,8 @@ export type CustomElementsSolidJs = {
|
|
|
3003
3007
|
>;
|
|
3004
3008
|
|
|
3005
3009
|
/**
|
|
3006
|
-
*
|
|
3010
|
+
* Performs an action or renders a link with button styling.
|
|
3011
|
+
* Use button variants to match action priority, risk, and context.
|
|
3007
3012
|
*
|
|
3008
3013
|
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/buttons-button--docs)
|
|
3009
3014
|
*
|
|
@@ -3011,22 +3016,38 @@ export type CustomElementsSolidJs = {
|
|
|
3011
3016
|
*
|
|
3012
3017
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3013
3018
|
*
|
|
3014
|
-
* - `type`:
|
|
3015
|
-
*
|
|
3016
|
-
* - `
|
|
3017
|
-
*
|
|
3018
|
-
* - `
|
|
3019
|
-
*
|
|
3020
|
-
* - `
|
|
3021
|
-
*
|
|
3022
|
-
* - `
|
|
3023
|
-
*
|
|
3024
|
-
* - `
|
|
3025
|
-
*
|
|
3026
|
-
* - `
|
|
3027
|
-
*
|
|
3028
|
-
* - `
|
|
3029
|
-
*
|
|
3019
|
+
* - `type`: Native button type.
|
|
3020
|
+
* Controls whether the internal button behaves as a regular button, submits a form, or resets a form. Defaults to `button`.
|
|
3021
|
+
* - `autofocus`: Focuses the button when it is first rendered.
|
|
3022
|
+
* Applies only when the component renders a native button. Link buttons with `href` do not autofocus through this component.
|
|
3023
|
+
* - `variant`: Visual style of the button.
|
|
3024
|
+
* Defaults to `secondary`. Use the variant that matches the action priority, risk, and placement.
|
|
3025
|
+
* - `quiet`: Deprecated quiet visual treatment flag
|
|
3026
|
+
* Use `variant="quiet"` instead.
|
|
3027
|
+
* - `icon-only`/`iconOnly`: Marks the button as icon-only.
|
|
3028
|
+
* Use this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name.
|
|
3029
|
+
* - `small`: Renders the compact button size.
|
|
3030
|
+
* Use this in dense layouts where the default button size is too large.
|
|
3031
|
+
* - `loading`: Shows the loading state.
|
|
3032
|
+
* Use after the user has triggered an action and the action is in progress.
|
|
3033
|
+
* - `href`: URL for rendering the button as a link.
|
|
3034
|
+
* When set, the component renders `w-link` instead of a native `button`.
|
|
3035
|
+
* - `target`: Link browsing context.
|
|
3036
|
+
* Passed to the rendered link when `href` is set.
|
|
3037
|
+
* - `disabled`: Visually disables the button.
|
|
3038
|
+
* Disabled buttons are discouraged because they can hide the reason an action is unavailable.
|
|
3039
|
+
* - `rel`: Link relationship.
|
|
3040
|
+
* Passed to the rendered link when `href` is set. If `target="_blank"` is set and `rel` is omitted, `noopener` is used.
|
|
3041
|
+
* - `full-width`/`fullWidth`: Makes the button fill its parent width.
|
|
3042
|
+
* Useful in narrow layouts where the button should span the available inline space.
|
|
3043
|
+
* - `button-class`/`buttonClass`: Deprecated class applied to the internal control
|
|
3044
|
+
* This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance.
|
|
3045
|
+
* - `name`: Form control name.
|
|
3046
|
+
* Used when the button participates in form handling.
|
|
3047
|
+
* - `value`: Form control value.
|
|
3048
|
+
* Used with `name` when the button participates in form handling. Resets to its initial value when the form is reset.
|
|
3049
|
+
* - `commandfor`: The [commandfor HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.
|
|
3050
|
+
* - `command`: The [command HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.
|
|
3030
3051
|
*
|
|
3031
3052
|
* ## Methods
|
|
3032
3053
|
*
|
|
@@ -3392,18 +3413,15 @@ export type CustomElementsSolidJs = {
|
|
|
3392
3413
|
/**
|
|
3393
3414
|
* Modals (or dialogs) display important information that users need to acknowledge.
|
|
3394
3415
|
*
|
|
3395
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
3396
|
-
*
|
|
3397
3416
|
* ## Attributes & Properties
|
|
3398
3417
|
*
|
|
3399
3418
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3400
3419
|
*
|
|
3401
|
-
* - `show`:
|
|
3420
|
+
* - `show`: Controls if the modal should show or hide.
|
|
3421
|
+
*
|
|
3422
|
+
* You can also call the `open()` and `close()` methods.
|
|
3402
3423
|
* - `content-id`/`contentId`: undefined
|
|
3403
|
-
* - `ignore-backdrop-clicks`/`ignoreBackdropClicks`:
|
|
3404
|
-
* - `dialogEl`: undefined (property only)
|
|
3405
|
-
* - `dialogInnerEl`: undefined (property only)
|
|
3406
|
-
* - `contentEl`: undefined (property only)
|
|
3424
|
+
* - `ignore-backdrop-clicks`/`ignoreBackdropClicks`: Ignores clicks to the backdrop when set
|
|
3407
3425
|
*
|
|
3408
3426
|
* ## Events
|
|
3409
3427
|
*
|
|
@@ -3426,44 +3444,31 @@ export type CustomElementsSolidJs = {
|
|
|
3426
3444
|
*
|
|
3427
3445
|
* - `open() => void`: undefined
|
|
3428
3446
|
* - `close() => void`: undefined
|
|
3429
|
-
* - `handleListeners(verb = 'addEventListener') => void`: undefined
|
|
3430
|
-
* - `eventPreventer(evt: Event) => void`: undefined
|
|
3431
|
-
* - `closeOnBackdropClick(evt: MouseEvent) => void`: undefined
|
|
3432
|
-
* - `interceptEscape(evt: KeyboardEvent) => void`: undefined
|
|
3433
|
-
* - `modifyBorderRadius() => void`: undefined
|
|
3434
3447
|
*/
|
|
3435
3448
|
"w-modal": Partial<
|
|
3436
|
-
|
|
3449
|
+
WarpModalProps & WarpModalSolidJsProps & BaseProps<WarpModal> & BaseEvents
|
|
3437
3450
|
>;
|
|
3438
3451
|
|
|
3439
3452
|
/**
|
|
3440
3453
|
* The footer section of a modal, typically where you place actions.
|
|
3441
|
-
*
|
|
3442
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
3443
3454
|
*/
|
|
3444
3455
|
"w-modal-footer": Partial<
|
|
3445
|
-
|
|
3446
|
-
|
|
3447
|
-
BaseProps<
|
|
3456
|
+
WarpModalFooterProps &
|
|
3457
|
+
WarpModalFooterSolidJsProps &
|
|
3458
|
+
BaseProps<WarpModalFooter> &
|
|
3448
3459
|
BaseEvents
|
|
3449
3460
|
>;
|
|
3450
3461
|
|
|
3451
3462
|
/**
|
|
3452
3463
|
* The header section of a modal, typically where you place the title and a close button.
|
|
3453
3464
|
*
|
|
3454
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
3455
|
-
*
|
|
3456
3465
|
* ## Attributes & Properties
|
|
3457
3466
|
*
|
|
3458
3467
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3459
3468
|
*
|
|
3460
|
-
* - `title`:
|
|
3461
|
-
* - `back`:
|
|
3462
|
-
* - `no-close`/`noClose`:
|
|
3463
|
-
* - `titleEl`: undefined (property only)
|
|
3464
|
-
* - `titleClasses`: undefined (property only) (readonly)
|
|
3465
|
-
* - `backButton`: undefined (property only) (readonly)
|
|
3466
|
-
* - `closeButton`: undefined (property only) (readonly)
|
|
3469
|
+
* - `title`: A short but descriptive title for the modal
|
|
3470
|
+
* - `back`: Whether the modal header should have a back button
|
|
3471
|
+
* - `no-close`/`noClose`: Lets you hide the close button in the header
|
|
3467
3472
|
*
|
|
3468
3473
|
* ## Events
|
|
3469
3474
|
*
|
|
@@ -3476,31 +3481,25 @@ export type CustomElementsSolidJs = {
|
|
|
3476
3481
|
* Areas where markup can be added to the component.
|
|
3477
3482
|
*
|
|
3478
3483
|
* - `top`: Customize the title bar, for example to have a header image that reaches the modal's edges. See the With Image story for an example.
|
|
3479
|
-
*
|
|
3480
|
-
* ## Methods
|
|
3481
|
-
*
|
|
3482
|
-
* Methods that can be called to access component functionality.
|
|
3483
|
-
*
|
|
3484
|
-
* - `emitBack() => void`: undefined
|
|
3485
|
-
* - `handleTopSlotChange(slotEvent) => void`: undefined
|
|
3486
3484
|
*/
|
|
3487
3485
|
"w-modal-header": Partial<
|
|
3488
|
-
|
|
3489
|
-
|
|
3490
|
-
BaseProps<
|
|
3486
|
+
WarpModalHeaderProps &
|
|
3487
|
+
WarpModalHeaderSolidJsProps &
|
|
3488
|
+
BaseProps<WarpModalHeader> &
|
|
3491
3489
|
BaseEvents
|
|
3492
3490
|
>;
|
|
3493
3491
|
|
|
3494
3492
|
/**
|
|
3495
3493
|
* A page indicator component that displays a series of dots representing pages.
|
|
3494
|
+
*
|
|
3496
3495
|
* One dot is highlighted to indicate the currently selected page.
|
|
3497
3496
|
*
|
|
3498
3497
|
* ## Attributes & Properties
|
|
3499
3498
|
*
|
|
3500
3499
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3501
3500
|
*
|
|
3502
|
-
* - `selected-page`/`selectedPage`: Currently selected page (1-based index
|
|
3503
|
-
* - `page-count`/`pageCount`: Total number of pages
|
|
3501
|
+
* - `selected-page`/`selectedPage`: Currently selected page (1-based index)
|
|
3502
|
+
* - `page-count`/`pageCount`: Total number of pages
|
|
3504
3503
|
*/
|
|
3505
3504
|
"w-page-indicator": Partial<
|
|
3506
3505
|
WarpPageIndicatorProps &
|
|
@@ -3512,22 +3511,22 @@ export type CustomElementsSolidJs = {
|
|
|
3512
3511
|
/**
|
|
3513
3512
|
* Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.
|
|
3514
3513
|
*
|
|
3515
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/navigation-pagination--docs)
|
|
3516
|
-
*
|
|
3517
3514
|
* ## Attributes & Properties
|
|
3518
3515
|
*
|
|
3519
3516
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3520
3517
|
*
|
|
3521
|
-
* - `base-url`/`baseUrl`:
|
|
3522
|
-
*
|
|
3523
|
-
*
|
|
3524
|
-
* - `
|
|
3518
|
+
* - `base-url`/`baseUrl`: The base URL used to construct page links, for example `/search?page=`.
|
|
3519
|
+
*
|
|
3520
|
+
* The page number is appended to this URL.
|
|
3521
|
+
* - `pages`: The total number of pages.
|
|
3522
|
+
* - `current-page`/`currentPageNumber`: The currently active page number.
|
|
3523
|
+
* - `visible-pages`/`visiblePages`: The maximum number of page numbers visible.
|
|
3525
3524
|
*
|
|
3526
3525
|
* ## Events
|
|
3527
3526
|
*
|
|
3528
3527
|
* Events that will be emitted by the component.
|
|
3529
3528
|
*
|
|
3530
|
-
* - `page-click`: Triggered when a link
|
|
3529
|
+
* - `page-click`: Triggered when a link in the pagination is clicked. Contains the page number in `string` form.
|
|
3531
3530
|
*/
|
|
3532
3531
|
"w-pagination": Partial<
|
|
3533
3532
|
WarpPaginationProps &
|
|
@@ -3539,27 +3538,23 @@ export type CustomElementsSolidJs = {
|
|
|
3539
3538
|
/**
|
|
3540
3539
|
* Pill is a type of button that is often used as a filter, but can also be used as a rounded button for overlays, etc.
|
|
3541
3540
|
*
|
|
3542
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/buttons-pill--docs)
|
|
3543
|
-
*
|
|
3544
3541
|
* ## Attributes & Properties
|
|
3545
3542
|
*
|
|
3546
3543
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3547
3544
|
*
|
|
3548
|
-
* - `can-close`/`canClose`:
|
|
3549
|
-
* - `suggestion`:
|
|
3545
|
+
* - `can-close`/`canClose`: Whether the pill should be removable via a close button.
|
|
3546
|
+
* - `suggestion`: Whether the pill should be rendered as a suggestion.
|
|
3550
3547
|
* - `open-sr-label`/`openSrLabel`: undefined
|
|
3551
|
-
* - `open-aria-label`/`openAriaLabel`:
|
|
3548
|
+
* - `open-aria-label`/`openAriaLabel`: Label read by screen readers when targeting the pill.
|
|
3552
3549
|
* - `close-sr-label`/`closeSrLabel`: undefined
|
|
3553
|
-
* - `close-aria-label`/`closeAriaLabel`:
|
|
3554
|
-
* - `openFilterSrText`: undefined (property only)
|
|
3555
|
-
* - `removeFilterSrText`: undefined (property only)
|
|
3550
|
+
* - `close-aria-label`/`closeAriaLabel`: Label read by screen readers when targeting the close button.
|
|
3556
3551
|
*
|
|
3557
3552
|
* ## Events
|
|
3558
3553
|
*
|
|
3559
3554
|
* Events that will be emitted by the component.
|
|
3560
3555
|
*
|
|
3561
|
-
* - `w-pill-click`:
|
|
3562
|
-
* - `w-pill-close`:
|
|
3556
|
+
* - `w-pill-click`: Fires when the pill itself is clicked.
|
|
3557
|
+
* - `w-pill-close`: Fires when the pill's close button is clicked.
|
|
3563
3558
|
*/
|
|
3564
3559
|
"w-pill": Partial<
|
|
3565
3560
|
WarpPillProps & WarpPillSolidJsProps & BaseProps<WarpPill> & BaseEvents
|
|
@@ -3578,41 +3573,29 @@ export type CustomElementsSolidJs = {
|
|
|
3578
3573
|
* - `disabled`: Disables the radio.
|
|
3579
3574
|
* - `required`: Makes the radio a required field.
|
|
3580
3575
|
* - `invalid`: Draws the radio in an invalid state.
|
|
3581
|
-
* - `tabIndex`: Override tabIndex setter to set _groupTabIndex (for backwards compatibility).
|
|
3582
|
-
* Radio-group should use _groupTabIndex directly for clarity. (property only)
|
|
3583
|
-
* - `validationMessage`: Returns the validation message if the radio is invalid, otherwise an empty string (property only) (readonly)
|
|
3584
|
-
* - `validity`: Returns the validity state of the radio (property only) (readonly)
|
|
3585
|
-
* - `_standaloneTabIndex`: Internal tabindex for standalone radios (not in a group).
|
|
3586
|
-
* Non-reflecting to avoid DOM changes during hydration. (property only)
|
|
3587
|
-
*
|
|
3588
|
-
* ## Methods
|
|
3589
|
-
*
|
|
3590
|
-
* Methods that can be called to access component functionality.
|
|
3591
|
-
*
|
|
3592
|
-
* - `resetFormControl() => void`: undefined
|
|
3593
|
-
* - `checkValidity() => boolean`: Checks whether the radio passes constraint validation
|
|
3594
|
-
* - `reportValidity() => boolean`: Checks validity and shows the browser's validation message if invalid
|
|
3595
3576
|
*/
|
|
3596
3577
|
"w-radio": Partial<
|
|
3597
|
-
|
|
3578
|
+
WarpRadioProps & WarpRadioSolidJsProps & BaseProps<WarpRadio> & BaseEvents
|
|
3598
3579
|
>;
|
|
3599
3580
|
|
|
3600
3581
|
/**
|
|
3582
|
+
* Radios allow users to select a single option from a list of choices.
|
|
3601
3583
|
*
|
|
3584
|
+
* Use with `w-radio`.
|
|
3602
3585
|
*
|
|
3603
3586
|
* ## Attributes & Properties
|
|
3604
3587
|
*
|
|
3605
3588
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3606
3589
|
*
|
|
3607
|
-
* - `label`:
|
|
3608
|
-
* - `help-text`/`helpText`:
|
|
3609
|
-
*
|
|
3610
|
-
*
|
|
3611
|
-
* - `
|
|
3612
|
-
* - `
|
|
3613
|
-
* - `
|
|
3614
|
-
* - `
|
|
3615
|
-
* - `
|
|
3590
|
+
* - `label`: Label for the radio group.
|
|
3591
|
+
* - `help-text`/`helpText`: Help text for the radio group.
|
|
3592
|
+
*
|
|
3593
|
+
* If you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute.
|
|
3594
|
+
* - `optional`: Whether to show optional text next to the label.
|
|
3595
|
+
* - `invalid`: Marks the radio group as invalid.
|
|
3596
|
+
* - `name`: The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.
|
|
3597
|
+
* - `disabled`: Disables the radio group and all child radios.
|
|
3598
|
+
* - `required`: Makes selecting a radio in the the group required.
|
|
3616
3599
|
*
|
|
3617
3600
|
* ## Slots
|
|
3618
3601
|
*
|
|
@@ -3620,60 +3603,44 @@ export type CustomElementsSolidJs = {
|
|
|
3620
3603
|
*
|
|
3621
3604
|
* - `label`: Alternative to the `label` attribute should you need custom HTML.
|
|
3622
3605
|
* - `help-text`: Alternative to the `help-text` attribute should you need custom HTML.
|
|
3623
|
-
*
|
|
3624
|
-
* ## Methods
|
|
3625
|
-
*
|
|
3626
|
-
* Methods that can be called to access component functionality.
|
|
3627
|
-
*
|
|
3628
|
-
* - `resetFormControl() => void`: undefined
|
|
3629
|
-
* - `focus(options?: FocusOptions) => void`: undefined
|
|
3630
|
-
* - `checkValidity() => void`: undefined
|
|
3631
|
-
* - `reportValidity() => void`: undefined
|
|
3632
3606
|
*/
|
|
3633
3607
|
"w-radio-group": Partial<
|
|
3634
|
-
|
|
3635
|
-
|
|
3636
|
-
BaseProps<
|
|
3608
|
+
WarpRadioGroupProps &
|
|
3609
|
+
WarpRadioGroupSolidJsProps &
|
|
3610
|
+
BaseProps<WarpRadioGroup> &
|
|
3637
3611
|
BaseEvents
|
|
3638
3612
|
>;
|
|
3639
3613
|
|
|
3640
3614
|
/**
|
|
3641
3615
|
* A dropdown component for selecting a single value.
|
|
3642
3616
|
*
|
|
3643
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/forms-select--docs)
|
|
3644
|
-
*
|
|
3645
3617
|
* ## Attributes & Properties
|
|
3646
3618
|
*
|
|
3647
3619
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3648
3620
|
*
|
|
3649
3621
|
* - `auto-focus`/`autoFocus`: Whether the element should receive focus on render.
|
|
3650
3622
|
* - `autofocus`: Whether the element should receive focus on render
|
|
3651
|
-
* - `help-text`/`helpText`: The content displayed as the help text.
|
|
3652
|
-
*
|
|
3623
|
+
* - `help-text`/`helpText`: The content displayed as the help text.
|
|
3624
|
+
*
|
|
3625
|
+
* Paired with `invalid` to show the text as a validation error.
|
|
3626
|
+
* - `invalid`: Renders the field in an invalid state.
|
|
3627
|
+
*
|
|
3628
|
+
* Paired with `help-text` to provide feedback about the error.
|
|
3653
3629
|
* - `always`: Whether to always show a hint.
|
|
3654
3630
|
* - `hint`: The content displayed as the help text.
|
|
3655
|
-
* - `label`: The content to
|
|
3656
|
-
* - `optional`: Whether to show optional
|
|
3631
|
+
* - `label`: The content to display as the label.
|
|
3632
|
+
* - `optional`: Whether to show the optional indicator after the label.
|
|
3657
3633
|
* - `disabled`: Renders the field in a disabled state.
|
|
3658
3634
|
* - `read-only`/`readOnly`: Renders the field in a readonly state.
|
|
3659
3635
|
* - `readonly`: Renders the field in a readonly state.
|
|
3660
|
-
* - `name`:
|
|
3661
|
-
* - `value`:
|
|
3636
|
+
* - `name`: The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.
|
|
3637
|
+
* - `value`: Lets you set the current value.
|
|
3662
3638
|
*
|
|
3663
3639
|
* ## Events
|
|
3664
3640
|
*
|
|
3665
3641
|
* Events that will be emitted by the component.
|
|
3666
3642
|
*
|
|
3667
3643
|
* - `change`: undefined
|
|
3668
|
-
*
|
|
3669
|
-
* ## Methods
|
|
3670
|
-
*
|
|
3671
|
-
* Methods that can be called to access component functionality.
|
|
3672
|
-
*
|
|
3673
|
-
* - `resetFormControl() => void`: undefined
|
|
3674
|
-
* - `formStateRestoreCallback(state: string | File | FormData | null, _reason: 'autocomplete' | 'restore') => void`: undefined
|
|
3675
|
-
* - `handleKeyDown(event: KeyboardEvent) => void`: undefined
|
|
3676
|
-
* - `onChange(event: Event) => void`: undefined
|
|
3677
3644
|
*/
|
|
3678
3645
|
"w-select": Partial<
|
|
3679
3646
|
WarpSelectProps &
|