@warp-ds/elements 2.9.2-next.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 +275 -58
- 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/index.d.ts +305 -289
- 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/web-types.json +272 -70
- package/package.json +5 -5
package/dist/index.d.ts
CHANGED
|
@@ -14,9 +14,15 @@ 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";
|
|
@@ -384,85 +390,125 @@ export type WarpLinkSolidJsProps = {
|
|
|
384
390
|
};
|
|
385
391
|
|
|
386
392
|
export type WarpButtonProps = {
|
|
387
|
-
/**
|
|
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`. */
|
|
388
395
|
type?: WarpButton["type"];
|
|
389
|
-
/**
|
|
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. */
|
|
390
398
|
autofocus?: WarpButton["autofocus"];
|
|
391
|
-
/**
|
|
399
|
+
/** Visual style of the button.
|
|
400
|
+
Defaults to `secondary`. Use the variant that matches the action priority, risk, and placement. */
|
|
392
401
|
variant?: WarpButton["variant"];
|
|
393
|
-
/** @deprecated Use `variant="quiet"` instead
|
|
402
|
+
/** @deprecated Use `variant="quiet"` instead - Deprecated quiet visual treatment flag
|
|
403
|
+
Use `variant="quiet"` instead. */
|
|
394
404
|
quiet?: WarpButton["quiet"];
|
|
395
|
-
/**
|
|
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. */
|
|
396
407
|
"icon-only"?: WarpButton["iconOnly"];
|
|
397
|
-
/**
|
|
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. */
|
|
398
410
|
iconOnly?: WarpButton["iconOnly"];
|
|
399
|
-
/**
|
|
411
|
+
/** Renders the compact button size.
|
|
412
|
+
Use this in dense layouts where the default button size is too large. */
|
|
400
413
|
small?: WarpButton["small"];
|
|
401
|
-
/**
|
|
414
|
+
/** Shows the loading state.
|
|
415
|
+
Use after the user has triggered an action and the action is in progress. */
|
|
402
416
|
loading?: WarpButton["loading"];
|
|
403
|
-
/**
|
|
417
|
+
/** URL for rendering the button as a link.
|
|
418
|
+
When set, the component renders `w-link` instead of a native `button`. */
|
|
404
419
|
href?: WarpButton["href"];
|
|
405
|
-
/**
|
|
420
|
+
/** Link browsing context.
|
|
421
|
+
Passed to the rendered link when `href` is set. */
|
|
406
422
|
target?: WarpButton["target"];
|
|
407
|
-
/**
|
|
423
|
+
/** Visually disables the button.
|
|
424
|
+
Disabled buttons are discouraged because they can hide the reason an action is unavailable. */
|
|
408
425
|
disabled?: WarpButton["disabled"];
|
|
409
|
-
/**
|
|
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. */
|
|
410
428
|
rel?: WarpButton["rel"];
|
|
411
|
-
/**
|
|
429
|
+
/** Makes the button fill its parent width.
|
|
430
|
+
Useful in narrow layouts where the button should span the available inline space. */
|
|
412
431
|
"full-width"?: WarpButton["fullWidth"];
|
|
413
|
-
/**
|
|
432
|
+
/** Makes the button fill its parent width.
|
|
433
|
+
Useful in narrow layouts where the button should span the available inline space. */
|
|
414
434
|
fullWidth?: WarpButton["fullWidth"];
|
|
415
|
-
/** @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. */
|
|
416
437
|
"button-class"?: WarpButton["buttonClass"];
|
|
417
|
-
/** @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. */
|
|
418
440
|
buttonClass?: WarpButton["buttonClass"];
|
|
419
|
-
/**
|
|
441
|
+
/** Form control name.
|
|
442
|
+
Used when the button participates in form handling. */
|
|
420
443
|
name?: WarpButton["name"];
|
|
421
|
-
/**
|
|
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. */
|
|
422
446
|
value?: WarpButton["value"];
|
|
423
|
-
/**
|
|
424
|
-
|
|
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"];
|
|
425
451
|
};
|
|
426
452
|
|
|
427
453
|
export type WarpButtonSolidJsProps = {
|
|
428
|
-
/**
|
|
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`. */
|
|
429
456
|
"prop:type"?: WarpButton["type"];
|
|
430
|
-
/**
|
|
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. */
|
|
431
459
|
"prop:autofocus"?: WarpButton["autofocus"];
|
|
432
|
-
/**
|
|
460
|
+
/** Visual style of the button.
|
|
461
|
+
Defaults to `secondary`. Use the variant that matches the action priority, risk, and placement. */
|
|
433
462
|
"prop:variant"?: WarpButton["variant"];
|
|
434
|
-
/** @deprecated Use `variant="quiet"` instead
|
|
463
|
+
/** @deprecated Use `variant="quiet"` instead - Deprecated quiet visual treatment flag
|
|
464
|
+
Use `variant="quiet"` instead. */
|
|
435
465
|
"prop:quiet"?: WarpButton["quiet"];
|
|
436
|
-
/**
|
|
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. */
|
|
437
468
|
"bool:icon-only"?: WarpButton["iconOnly"];
|
|
438
|
-
/**
|
|
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. */
|
|
439
471
|
"prop:iconOnly"?: WarpButton["iconOnly"];
|
|
440
|
-
/**
|
|
472
|
+
/** Renders the compact button size.
|
|
473
|
+
Use this in dense layouts where the default button size is too large. */
|
|
441
474
|
"prop:small"?: WarpButton["small"];
|
|
442
|
-
/**
|
|
475
|
+
/** Shows the loading state.
|
|
476
|
+
Use after the user has triggered an action and the action is in progress. */
|
|
443
477
|
"prop:loading"?: WarpButton["loading"];
|
|
444
|
-
/**
|
|
478
|
+
/** URL for rendering the button as a link.
|
|
479
|
+
When set, the component renders `w-link` instead of a native `button`. */
|
|
445
480
|
"prop:href"?: WarpButton["href"];
|
|
446
|
-
/**
|
|
481
|
+
/** Link browsing context.
|
|
482
|
+
Passed to the rendered link when `href` is set. */
|
|
447
483
|
"prop:target"?: WarpButton["target"];
|
|
448
|
-
/**
|
|
484
|
+
/** Visually disables the button.
|
|
485
|
+
Disabled buttons are discouraged because they can hide the reason an action is unavailable. */
|
|
449
486
|
"prop:disabled"?: WarpButton["disabled"];
|
|
450
|
-
/**
|
|
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. */
|
|
451
489
|
"prop:rel"?: WarpButton["rel"];
|
|
452
|
-
/**
|
|
490
|
+
/** Makes the button fill its parent width.
|
|
491
|
+
Useful in narrow layouts where the button should span the available inline space. */
|
|
453
492
|
"bool:full-width"?: WarpButton["fullWidth"];
|
|
454
|
-
/**
|
|
493
|
+
/** Makes the button fill its parent width.
|
|
494
|
+
Useful in narrow layouts where the button should span the available inline space. */
|
|
455
495
|
"prop:fullWidth"?: WarpButton["fullWidth"];
|
|
456
|
-
/** @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. */
|
|
457
498
|
"attr:button-class"?: WarpButton["buttonClass"];
|
|
458
|
-
/** @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. */
|
|
459
501
|
"prop:buttonClass"?: WarpButton["buttonClass"];
|
|
460
|
-
/**
|
|
502
|
+
/** Form control name.
|
|
503
|
+
Used when the button participates in form handling. */
|
|
461
504
|
"prop:name"?: WarpButton["name"];
|
|
462
|
-
/**
|
|
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. */
|
|
463
507
|
"prop:value"?: WarpButton["value"];
|
|
464
|
-
/**
|
|
465
|
-
"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"];
|
|
466
512
|
|
|
467
513
|
/** Set the innerHTML of the element */
|
|
468
514
|
innerHTML?: string;
|
|
@@ -1079,23 +1125,19 @@ export type WarpExpandableSolidJsProps = {
|
|
|
1079
1125
|
textContent?: string | number;
|
|
1080
1126
|
};
|
|
1081
1127
|
|
|
1082
|
-
export type
|
|
1083
|
-
/**
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
/** */
|
|
1088
|
-
contentId?: ModalMain["contentId"];
|
|
1089
|
-
/** */
|
|
1090
|
-
"ignore-backdrop-clicks"?: ModalMain["ignoreBackdropClicks"];
|
|
1091
|
-
/** */
|
|
1092
|
-
ignoreBackdropClicks?: ModalMain["ignoreBackdropClicks"];
|
|
1093
|
-
/** */
|
|
1094
|
-
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"];
|
|
1095
1133
|
/** */
|
|
1096
|
-
|
|
1134
|
+
"content-id"?: WarpModal["contentId"];
|
|
1097
1135
|
/** */
|
|
1098
|
-
|
|
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"];
|
|
1099
1141
|
|
|
1100
1142
|
/** */
|
|
1101
1143
|
onshown?: (e: CustomEvent) => void;
|
|
@@ -1103,23 +1145,19 @@ export type ModalMainProps = {
|
|
|
1103
1145
|
onhidden?: (e: CustomEvent) => void;
|
|
1104
1146
|
};
|
|
1105
1147
|
|
|
1106
|
-
export type
|
|
1107
|
-
/**
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
"
|
|
1111
|
-
/** */
|
|
1112
|
-
"prop:contentId"?: ModalMain["contentId"];
|
|
1113
|
-
/** */
|
|
1114
|
-
"bool:ignore-backdrop-clicks"?: ModalMain["ignoreBackdropClicks"];
|
|
1115
|
-
/** */
|
|
1116
|
-
"prop:ignoreBackdropClicks"?: ModalMain["ignoreBackdropClicks"];
|
|
1117
|
-
/** */
|
|
1118
|
-
"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"];
|
|
1119
1153
|
/** */
|
|
1120
|
-
"
|
|
1154
|
+
"attr:content-id"?: WarpModal["contentId"];
|
|
1121
1155
|
/** */
|
|
1122
|
-
"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"];
|
|
1123
1161
|
/** */
|
|
1124
1162
|
"on:shown"?: (e: CustomEvent) => void;
|
|
1125
1163
|
/** */
|
|
@@ -1131,42 +1169,38 @@ export type ModalMainSolidJsProps = {
|
|
|
1131
1169
|
textContent?: string | number;
|
|
1132
1170
|
};
|
|
1133
1171
|
|
|
1134
|
-
export type
|
|
1172
|
+
export type WarpModalFooterProps = {};
|
|
1135
1173
|
|
|
1136
|
-
export type
|
|
1174
|
+
export type WarpModalFooterSolidJsProps = {
|
|
1137
1175
|
/** Set the innerHTML of the element */
|
|
1138
1176
|
innerHTML?: string;
|
|
1139
1177
|
/** Set the textContent of the element */
|
|
1140
1178
|
textContent?: string | number;
|
|
1141
1179
|
};
|
|
1142
1180
|
|
|
1143
|
-
export type
|
|
1144
|
-
/**
|
|
1145
|
-
title?:
|
|
1146
|
-
/**
|
|
1147
|
-
back?:
|
|
1148
|
-
/**
|
|
1149
|
-
"no-close"?:
|
|
1150
|
-
/**
|
|
1151
|
-
noClose?:
|
|
1152
|
-
/** */
|
|
1153
|
-
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"];
|
|
1154
1190
|
|
|
1155
1191
|
/** */
|
|
1156
1192
|
onbackClicked?: (e: CustomEvent) => void;
|
|
1157
1193
|
};
|
|
1158
1194
|
|
|
1159
|
-
export type
|
|
1160
|
-
/**
|
|
1161
|
-
"prop:title"?:
|
|
1162
|
-
/**
|
|
1163
|
-
"prop:back"?:
|
|
1164
|
-
/**
|
|
1165
|
-
"bool:no-close"?:
|
|
1166
|
-
/**
|
|
1167
|
-
"prop:noClose"?:
|
|
1168
|
-
/** */
|
|
1169
|
-
"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"];
|
|
1170
1204
|
/** */
|
|
1171
1205
|
"on:backClicked"?: (e: CustomEvent) => void;
|
|
1172
1206
|
|
|
@@ -1177,24 +1211,24 @@ export type ModalHeaderSolidJsProps = {
|
|
|
1177
1211
|
};
|
|
1178
1212
|
|
|
1179
1213
|
export type WarpPageIndicatorProps = {
|
|
1180
|
-
/** Currently selected page (1-based index
|
|
1214
|
+
/** Currently selected page (1-based index) */
|
|
1181
1215
|
"selected-page"?: WarpPageIndicator["selectedPage"];
|
|
1182
|
-
/** Currently selected page (1-based index
|
|
1216
|
+
/** Currently selected page (1-based index) */
|
|
1183
1217
|
selectedPage?: WarpPageIndicator["selectedPage"];
|
|
1184
|
-
/** Total number of pages
|
|
1218
|
+
/** Total number of pages */
|
|
1185
1219
|
"page-count"?: WarpPageIndicator["pageCount"];
|
|
1186
|
-
/** Total number of pages
|
|
1220
|
+
/** Total number of pages */
|
|
1187
1221
|
pageCount?: WarpPageIndicator["pageCount"];
|
|
1188
1222
|
};
|
|
1189
1223
|
|
|
1190
1224
|
export type WarpPageIndicatorSolidJsProps = {
|
|
1191
|
-
/** Currently selected page (1-based index
|
|
1225
|
+
/** Currently selected page (1-based index) */
|
|
1192
1226
|
"attr:selected-page"?: WarpPageIndicator["selectedPage"];
|
|
1193
|
-
/** Currently selected page (1-based index
|
|
1227
|
+
/** Currently selected page (1-based index) */
|
|
1194
1228
|
"prop:selectedPage"?: WarpPageIndicator["selectedPage"];
|
|
1195
|
-
/** Total number of pages
|
|
1229
|
+
/** Total number of pages */
|
|
1196
1230
|
"attr:page-count"?: WarpPageIndicator["pageCount"];
|
|
1197
|
-
/** Total number of pages
|
|
1231
|
+
/** Total number of pages */
|
|
1198
1232
|
"prop:pageCount"?: WarpPageIndicator["pageCount"];
|
|
1199
1233
|
|
|
1200
1234
|
/** Set the innerHTML of the element */
|
|
@@ -1204,41 +1238,49 @@ export type WarpPageIndicatorSolidJsProps = {
|
|
|
1204
1238
|
};
|
|
1205
1239
|
|
|
1206
1240
|
export type WarpPaginationProps = {
|
|
1207
|
-
/**
|
|
1241
|
+
/** The base URL used to construct page links, for example `/search?page=`.
|
|
1242
|
+
|
|
1243
|
+
The page number is appended to this URL. */
|
|
1208
1244
|
"base-url"?: WarpPagination["baseUrl"];
|
|
1209
|
-
/**
|
|
1245
|
+
/** The base URL used to construct page links, for example `/search?page=`.
|
|
1246
|
+
|
|
1247
|
+
The page number is appended to this URL. */
|
|
1210
1248
|
baseUrl?: WarpPagination["baseUrl"];
|
|
1211
|
-
/**
|
|
1249
|
+
/** The total number of pages. */
|
|
1212
1250
|
pages?: WarpPagination["pages"];
|
|
1213
|
-
/**
|
|
1251
|
+
/** The currently active page number. */
|
|
1214
1252
|
"current-page"?: WarpPagination["currentPageNumber"];
|
|
1215
|
-
/**
|
|
1253
|
+
/** The currently active page number. */
|
|
1216
1254
|
currentPageNumber?: WarpPagination["currentPageNumber"];
|
|
1217
|
-
/**
|
|
1255
|
+
/** The maximum number of page numbers visible. */
|
|
1218
1256
|
"visible-pages"?: WarpPagination["visiblePages"];
|
|
1219
|
-
/**
|
|
1257
|
+
/** The maximum number of page numbers visible. */
|
|
1220
1258
|
visiblePages?: WarpPagination["visiblePages"];
|
|
1221
1259
|
|
|
1222
|
-
/** Triggered when a link
|
|
1260
|
+
/** Triggered when a link in the pagination is clicked. Contains the page number in `string` form. */
|
|
1223
1261
|
"onpage-click"?: (e: CustomEvent) => void;
|
|
1224
1262
|
};
|
|
1225
1263
|
|
|
1226
1264
|
export type WarpPaginationSolidJsProps = {
|
|
1227
|
-
/**
|
|
1265
|
+
/** The base URL used to construct page links, for example `/search?page=`.
|
|
1266
|
+
|
|
1267
|
+
The page number is appended to this URL. */
|
|
1228
1268
|
"attr:base-url"?: WarpPagination["baseUrl"];
|
|
1229
|
-
/**
|
|
1269
|
+
/** The base URL used to construct page links, for example `/search?page=`.
|
|
1270
|
+
|
|
1271
|
+
The page number is appended to this URL. */
|
|
1230
1272
|
"prop:baseUrl"?: WarpPagination["baseUrl"];
|
|
1231
|
-
/**
|
|
1273
|
+
/** The total number of pages. */
|
|
1232
1274
|
"prop:pages"?: WarpPagination["pages"];
|
|
1233
|
-
/**
|
|
1275
|
+
/** The currently active page number. */
|
|
1234
1276
|
"attr:current-page"?: WarpPagination["currentPageNumber"];
|
|
1235
|
-
/**
|
|
1277
|
+
/** The currently active page number. */
|
|
1236
1278
|
"prop:currentPageNumber"?: WarpPagination["currentPageNumber"];
|
|
1237
|
-
/**
|
|
1279
|
+
/** The maximum number of page numbers visible. */
|
|
1238
1280
|
"attr:visible-pages"?: WarpPagination["visiblePages"];
|
|
1239
|
-
/**
|
|
1281
|
+
/** The maximum number of page numbers visible. */
|
|
1240
1282
|
"prop:visiblePages"?: WarpPagination["visiblePages"];
|
|
1241
|
-
/** Triggered when a link
|
|
1283
|
+
/** Triggered when a link in the pagination is clicked. Contains the page number in `string` form. */
|
|
1242
1284
|
"on:page-click"?: (e: CustomEvent) => void;
|
|
1243
1285
|
|
|
1244
1286
|
/** Set the innerHTML of the element */
|
|
@@ -1248,69 +1290,61 @@ export type WarpPaginationSolidJsProps = {
|
|
|
1248
1290
|
};
|
|
1249
1291
|
|
|
1250
1292
|
export type WarpPillProps = {
|
|
1251
|
-
/**
|
|
1293
|
+
/** Whether the pill should be removable via a close button. */
|
|
1252
1294
|
"can-close"?: WarpPill["canClose"];
|
|
1253
|
-
/**
|
|
1295
|
+
/** Whether the pill should be removable via a close button. */
|
|
1254
1296
|
canClose?: WarpPill["canClose"];
|
|
1255
|
-
/**
|
|
1297
|
+
/** Whether the pill should be rendered as a suggestion. */
|
|
1256
1298
|
suggestion?: WarpPill["suggestion"];
|
|
1257
1299
|
/** @deprecated Used "open-arial-label" instead. */
|
|
1258
1300
|
"open-sr-label"?: WarpPill["openSrLabel"];
|
|
1259
1301
|
/** @deprecated Used "open-arial-label" instead. */
|
|
1260
1302
|
openSrLabel?: WarpPill["openSrLabel"];
|
|
1261
|
-
/**
|
|
1303
|
+
/** Label read by screen readers when targeting the pill. */
|
|
1262
1304
|
"open-aria-label"?: WarpPill["openAriaLabel"];
|
|
1263
|
-
/**
|
|
1305
|
+
/** Label read by screen readers when targeting the pill. */
|
|
1264
1306
|
openAriaLabel?: WarpPill["openAriaLabel"];
|
|
1265
1307
|
/** @deprecated Used "close-arial-label" instead. */
|
|
1266
1308
|
"close-sr-label"?: WarpPill["closeSrLabel"];
|
|
1267
1309
|
/** @deprecated Used "close-arial-label" instead. */
|
|
1268
1310
|
closeSrLabel?: WarpPill["closeSrLabel"];
|
|
1269
|
-
/**
|
|
1311
|
+
/** Label read by screen readers when targeting the close button. */
|
|
1270
1312
|
"close-aria-label"?: WarpPill["closeAriaLabel"];
|
|
1271
|
-
/**
|
|
1313
|
+
/** Label read by screen readers when targeting the close button. */
|
|
1272
1314
|
closeAriaLabel?: WarpPill["closeAriaLabel"];
|
|
1273
|
-
/** */
|
|
1274
|
-
openFilterSrText?: WarpPill["openFilterSrText"];
|
|
1275
|
-
/** */
|
|
1276
|
-
removeFilterSrText?: WarpPill["removeFilterSrText"];
|
|
1277
1315
|
|
|
1278
|
-
/**
|
|
1316
|
+
/** Fires when the pill itself is clicked. */
|
|
1279
1317
|
"onw-pill-click"?: (e: CustomEvent) => void;
|
|
1280
|
-
/**
|
|
1318
|
+
/** Fires when the pill's close button is clicked. */
|
|
1281
1319
|
"onw-pill-close"?: (e: CustomEvent) => void;
|
|
1282
1320
|
};
|
|
1283
1321
|
|
|
1284
1322
|
export type WarpPillSolidJsProps = {
|
|
1285
|
-
/**
|
|
1323
|
+
/** Whether the pill should be removable via a close button. */
|
|
1286
1324
|
"bool:can-close"?: WarpPill["canClose"];
|
|
1287
|
-
/**
|
|
1325
|
+
/** Whether the pill should be removable via a close button. */
|
|
1288
1326
|
"prop:canClose"?: WarpPill["canClose"];
|
|
1289
|
-
/**
|
|
1327
|
+
/** Whether the pill should be rendered as a suggestion. */
|
|
1290
1328
|
"prop:suggestion"?: WarpPill["suggestion"];
|
|
1291
1329
|
/** @deprecated Used "open-arial-label" instead. */
|
|
1292
1330
|
"attr:open-sr-label"?: WarpPill["openSrLabel"];
|
|
1293
1331
|
/** @deprecated Used "open-arial-label" instead. */
|
|
1294
1332
|
"prop:openSrLabel"?: WarpPill["openSrLabel"];
|
|
1295
|
-
/**
|
|
1333
|
+
/** Label read by screen readers when targeting the pill. */
|
|
1296
1334
|
"attr:open-aria-label"?: WarpPill["openAriaLabel"];
|
|
1297
|
-
/**
|
|
1335
|
+
/** Label read by screen readers when targeting the pill. */
|
|
1298
1336
|
"prop:openAriaLabel"?: WarpPill["openAriaLabel"];
|
|
1299
1337
|
/** @deprecated Used "close-arial-label" instead. */
|
|
1300
1338
|
"attr:close-sr-label"?: WarpPill["closeSrLabel"];
|
|
1301
1339
|
/** @deprecated Used "close-arial-label" instead. */
|
|
1302
1340
|
"prop:closeSrLabel"?: WarpPill["closeSrLabel"];
|
|
1303
|
-
/**
|
|
1341
|
+
/** Label read by screen readers when targeting the close button. */
|
|
1304
1342
|
"attr:close-aria-label"?: WarpPill["closeAriaLabel"];
|
|
1305
|
-
/**
|
|
1343
|
+
/** Label read by screen readers when targeting the close button. */
|
|
1306
1344
|
"prop:closeAriaLabel"?: WarpPill["closeAriaLabel"];
|
|
1307
|
-
/**
|
|
1308
|
-
"prop:openFilterSrText"?: WarpPill["openFilterSrText"];
|
|
1309
|
-
/** */
|
|
1310
|
-
"prop:removeFilterSrText"?: WarpPill["removeFilterSrText"];
|
|
1311
|
-
/** */
|
|
1345
|
+
/** Fires when the pill itself is clicked. */
|
|
1312
1346
|
"on:w-pill-click"?: (e: CustomEvent) => void;
|
|
1313
|
-
/**
|
|
1347
|
+
/** Fires when the pill's close button is clicked. */
|
|
1314
1348
|
"on:w-pill-close"?: (e: CustomEvent) => void;
|
|
1315
1349
|
|
|
1316
1350
|
/** Set the innerHTML of the element */
|
|
@@ -2010,7 +2044,8 @@ export type CustomElements = {
|
|
|
2010
2044
|
"w-link": Partial<WarpLinkProps & BaseProps<WarpLink> & BaseEvents>;
|
|
2011
2045
|
|
|
2012
2046
|
/**
|
|
2013
|
-
*
|
|
2047
|
+
* Performs an action or renders a link with button styling.
|
|
2048
|
+
* Use button variants to match action priority, risk, and context.
|
|
2014
2049
|
*
|
|
2015
2050
|
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/buttons-button--docs)
|
|
2016
2051
|
*
|
|
@@ -2018,22 +2053,38 @@ export type CustomElements = {
|
|
|
2018
2053
|
*
|
|
2019
2054
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2020
2055
|
*
|
|
2021
|
-
* - `type`:
|
|
2022
|
-
*
|
|
2023
|
-
* - `
|
|
2024
|
-
*
|
|
2025
|
-
* - `
|
|
2026
|
-
*
|
|
2027
|
-
* - `
|
|
2028
|
-
*
|
|
2029
|
-
* - `
|
|
2030
|
-
*
|
|
2031
|
-
* - `
|
|
2032
|
-
*
|
|
2033
|
-
* - `
|
|
2034
|
-
*
|
|
2035
|
-
* - `
|
|
2036
|
-
*
|
|
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.
|
|
2037
2088
|
*
|
|
2038
2089
|
* ## Methods
|
|
2039
2090
|
*
|
|
@@ -2368,18 +2419,15 @@ export type CustomElements = {
|
|
|
2368
2419
|
/**
|
|
2369
2420
|
* Modals (or dialogs) display important information that users need to acknowledge.
|
|
2370
2421
|
*
|
|
2371
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
2372
|
-
*
|
|
2373
2422
|
* ## Attributes & Properties
|
|
2374
2423
|
*
|
|
2375
2424
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2376
2425
|
*
|
|
2377
|
-
* - `show`:
|
|
2426
|
+
* - `show`: Controls if the modal should show or hide.
|
|
2427
|
+
*
|
|
2428
|
+
* You can also call the `open()` and `close()` methods.
|
|
2378
2429
|
* - `content-id`/`contentId`: undefined
|
|
2379
|
-
* - `ignore-backdrop-clicks`/`ignoreBackdropClicks`:
|
|
2380
|
-
* - `dialogEl`: undefined (property only)
|
|
2381
|
-
* - `dialogInnerEl`: undefined (property only)
|
|
2382
|
-
* - `contentEl`: undefined (property only)
|
|
2430
|
+
* - `ignore-backdrop-clicks`/`ignoreBackdropClicks`: Ignores clicks to the backdrop when set
|
|
2383
2431
|
*
|
|
2384
2432
|
* ## Events
|
|
2385
2433
|
*
|
|
@@ -2402,39 +2450,26 @@ export type CustomElements = {
|
|
|
2402
2450
|
*
|
|
2403
2451
|
* - `open() => void`: undefined
|
|
2404
2452
|
* - `close() => void`: undefined
|
|
2405
|
-
* - `handleListeners(verb = 'addEventListener') => void`: undefined
|
|
2406
|
-
* - `eventPreventer(evt: Event) => void`: undefined
|
|
2407
|
-
* - `closeOnBackdropClick(evt: MouseEvent) => void`: undefined
|
|
2408
|
-
* - `interceptEscape(evt: KeyboardEvent) => void`: undefined
|
|
2409
|
-
* - `modifyBorderRadius() => void`: undefined
|
|
2410
2453
|
*/
|
|
2411
|
-
"w-modal": Partial<
|
|
2454
|
+
"w-modal": Partial<WarpModalProps & BaseProps<WarpModal> & BaseEvents>;
|
|
2412
2455
|
|
|
2413
2456
|
/**
|
|
2414
2457
|
* The footer section of a modal, typically where you place actions.
|
|
2415
|
-
*
|
|
2416
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
2417
2458
|
*/
|
|
2418
2459
|
"w-modal-footer": Partial<
|
|
2419
|
-
|
|
2460
|
+
WarpModalFooterProps & BaseProps<WarpModalFooter> & BaseEvents
|
|
2420
2461
|
>;
|
|
2421
2462
|
|
|
2422
2463
|
/**
|
|
2423
2464
|
* The header section of a modal, typically where you place the title and a close button.
|
|
2424
2465
|
*
|
|
2425
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
2426
|
-
*
|
|
2427
2466
|
* ## Attributes & Properties
|
|
2428
2467
|
*
|
|
2429
2468
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2430
2469
|
*
|
|
2431
|
-
* - `title`:
|
|
2432
|
-
* - `back`:
|
|
2433
|
-
* - `no-close`/`noClose`:
|
|
2434
|
-
* - `titleEl`: undefined (property only)
|
|
2435
|
-
* - `titleClasses`: undefined (property only) (readonly)
|
|
2436
|
-
* - `backButton`: undefined (property only) (readonly)
|
|
2437
|
-
* - `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
|
|
2438
2473
|
*
|
|
2439
2474
|
* ## Events
|
|
2440
2475
|
*
|
|
@@ -2447,28 +2482,22 @@ export type CustomElements = {
|
|
|
2447
2482
|
* Areas where markup can be added to the component.
|
|
2448
2483
|
*
|
|
2449
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.
|
|
2450
|
-
*
|
|
2451
|
-
* ## Methods
|
|
2452
|
-
*
|
|
2453
|
-
* Methods that can be called to access component functionality.
|
|
2454
|
-
*
|
|
2455
|
-
* - `emitBack() => void`: undefined
|
|
2456
|
-
* - `handleTopSlotChange(slotEvent) => void`: undefined
|
|
2457
2485
|
*/
|
|
2458
2486
|
"w-modal-header": Partial<
|
|
2459
|
-
|
|
2487
|
+
WarpModalHeaderProps & BaseProps<WarpModalHeader> & BaseEvents
|
|
2460
2488
|
>;
|
|
2461
2489
|
|
|
2462
2490
|
/**
|
|
2463
2491
|
* A page indicator component that displays a series of dots representing pages.
|
|
2492
|
+
*
|
|
2464
2493
|
* One dot is highlighted to indicate the currently selected page.
|
|
2465
2494
|
*
|
|
2466
2495
|
* ## Attributes & Properties
|
|
2467
2496
|
*
|
|
2468
2497
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2469
2498
|
*
|
|
2470
|
-
* - `selected-page`/`selectedPage`: Currently selected page (1-based index
|
|
2471
|
-
* - `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
|
|
2472
2501
|
*/
|
|
2473
2502
|
"w-page-indicator": Partial<
|
|
2474
2503
|
WarpPageIndicatorProps & BaseProps<WarpPageIndicator> & BaseEvents
|
|
@@ -2477,22 +2506,22 @@ export type CustomElements = {
|
|
|
2477
2506
|
/**
|
|
2478
2507
|
* Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.
|
|
2479
2508
|
*
|
|
2480
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/navigation-pagination--docs)
|
|
2481
|
-
*
|
|
2482
2509
|
* ## Attributes & Properties
|
|
2483
2510
|
*
|
|
2484
2511
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2485
2512
|
*
|
|
2486
|
-
* - `base-url`/`baseUrl`:
|
|
2487
|
-
*
|
|
2488
|
-
*
|
|
2489
|
-
* - `
|
|
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.
|
|
2490
2519
|
*
|
|
2491
2520
|
* ## Events
|
|
2492
2521
|
*
|
|
2493
2522
|
* Events that will be emitted by the component.
|
|
2494
2523
|
*
|
|
2495
|
-
* - `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.
|
|
2496
2525
|
*/
|
|
2497
2526
|
"w-pagination": Partial<
|
|
2498
2527
|
WarpPaginationProps & BaseProps<WarpPagination> & BaseEvents
|
|
@@ -2501,27 +2530,23 @@ export type CustomElements = {
|
|
|
2501
2530
|
/**
|
|
2502
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.
|
|
2503
2532
|
*
|
|
2504
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/buttons-pill--docs)
|
|
2505
|
-
*
|
|
2506
2533
|
* ## Attributes & Properties
|
|
2507
2534
|
*
|
|
2508
2535
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2509
2536
|
*
|
|
2510
|
-
* - `can-close`/`canClose`:
|
|
2511
|
-
* - `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.
|
|
2512
2539
|
* - `open-sr-label`/`openSrLabel`: undefined
|
|
2513
|
-
* - `open-aria-label`/`openAriaLabel`:
|
|
2540
|
+
* - `open-aria-label`/`openAriaLabel`: Label read by screen readers when targeting the pill.
|
|
2514
2541
|
* - `close-sr-label`/`closeSrLabel`: undefined
|
|
2515
|
-
* - `close-aria-label`/`closeAriaLabel`:
|
|
2516
|
-
* - `openFilterSrText`: undefined (property only)
|
|
2517
|
-
* - `removeFilterSrText`: undefined (property only)
|
|
2542
|
+
* - `close-aria-label`/`closeAriaLabel`: Label read by screen readers when targeting the close button.
|
|
2518
2543
|
*
|
|
2519
2544
|
* ## Events
|
|
2520
2545
|
*
|
|
2521
2546
|
* Events that will be emitted by the component.
|
|
2522
2547
|
*
|
|
2523
|
-
* - `w-pill-click`:
|
|
2524
|
-
* - `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.
|
|
2525
2550
|
*/
|
|
2526
2551
|
"w-pill": Partial<WarpPillProps & BaseProps<WarpPill> & BaseEvents>;
|
|
2527
2552
|
|
|
@@ -2982,7 +3007,8 @@ export type CustomElementsSolidJs = {
|
|
|
2982
3007
|
>;
|
|
2983
3008
|
|
|
2984
3009
|
/**
|
|
2985
|
-
*
|
|
3010
|
+
* Performs an action or renders a link with button styling.
|
|
3011
|
+
* Use button variants to match action priority, risk, and context.
|
|
2986
3012
|
*
|
|
2987
3013
|
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/buttons-button--docs)
|
|
2988
3014
|
*
|
|
@@ -2990,22 +3016,38 @@ export type CustomElementsSolidJs = {
|
|
|
2990
3016
|
*
|
|
2991
3017
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2992
3018
|
*
|
|
2993
|
-
* - `type`:
|
|
2994
|
-
*
|
|
2995
|
-
* - `
|
|
2996
|
-
*
|
|
2997
|
-
* - `
|
|
2998
|
-
*
|
|
2999
|
-
* - `
|
|
3000
|
-
*
|
|
3001
|
-
* - `
|
|
3002
|
-
*
|
|
3003
|
-
* - `
|
|
3004
|
-
*
|
|
3005
|
-
* - `
|
|
3006
|
-
*
|
|
3007
|
-
* - `
|
|
3008
|
-
*
|
|
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.
|
|
3009
3051
|
*
|
|
3010
3052
|
* ## Methods
|
|
3011
3053
|
*
|
|
@@ -3371,18 +3413,15 @@ export type CustomElementsSolidJs = {
|
|
|
3371
3413
|
/**
|
|
3372
3414
|
* Modals (or dialogs) display important information that users need to acknowledge.
|
|
3373
3415
|
*
|
|
3374
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
3375
|
-
*
|
|
3376
3416
|
* ## Attributes & Properties
|
|
3377
3417
|
*
|
|
3378
3418
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3379
3419
|
*
|
|
3380
|
-
* - `show`:
|
|
3420
|
+
* - `show`: Controls if the modal should show or hide.
|
|
3421
|
+
*
|
|
3422
|
+
* You can also call the `open()` and `close()` methods.
|
|
3381
3423
|
* - `content-id`/`contentId`: undefined
|
|
3382
|
-
* - `ignore-backdrop-clicks`/`ignoreBackdropClicks`:
|
|
3383
|
-
* - `dialogEl`: undefined (property only)
|
|
3384
|
-
* - `dialogInnerEl`: undefined (property only)
|
|
3385
|
-
* - `contentEl`: undefined (property only)
|
|
3424
|
+
* - `ignore-backdrop-clicks`/`ignoreBackdropClicks`: Ignores clicks to the backdrop when set
|
|
3386
3425
|
*
|
|
3387
3426
|
* ## Events
|
|
3388
3427
|
*
|
|
@@ -3405,44 +3444,31 @@ export type CustomElementsSolidJs = {
|
|
|
3405
3444
|
*
|
|
3406
3445
|
* - `open() => void`: undefined
|
|
3407
3446
|
* - `close() => void`: undefined
|
|
3408
|
-
* - `handleListeners(verb = 'addEventListener') => void`: undefined
|
|
3409
|
-
* - `eventPreventer(evt: Event) => void`: undefined
|
|
3410
|
-
* - `closeOnBackdropClick(evt: MouseEvent) => void`: undefined
|
|
3411
|
-
* - `interceptEscape(evt: KeyboardEvent) => void`: undefined
|
|
3412
|
-
* - `modifyBorderRadius() => void`: undefined
|
|
3413
3447
|
*/
|
|
3414
3448
|
"w-modal": Partial<
|
|
3415
|
-
|
|
3449
|
+
WarpModalProps & WarpModalSolidJsProps & BaseProps<WarpModal> & BaseEvents
|
|
3416
3450
|
>;
|
|
3417
3451
|
|
|
3418
3452
|
/**
|
|
3419
3453
|
* The footer section of a modal, typically where you place actions.
|
|
3420
|
-
*
|
|
3421
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
3422
3454
|
*/
|
|
3423
3455
|
"w-modal-footer": Partial<
|
|
3424
|
-
|
|
3425
|
-
|
|
3426
|
-
BaseProps<
|
|
3456
|
+
WarpModalFooterProps &
|
|
3457
|
+
WarpModalFooterSolidJsProps &
|
|
3458
|
+
BaseProps<WarpModalFooter> &
|
|
3427
3459
|
BaseEvents
|
|
3428
3460
|
>;
|
|
3429
3461
|
|
|
3430
3462
|
/**
|
|
3431
3463
|
* The header section of a modal, typically where you place the title and a close button.
|
|
3432
3464
|
*
|
|
3433
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/overlays-modal--docs)
|
|
3434
|
-
*
|
|
3435
3465
|
* ## Attributes & Properties
|
|
3436
3466
|
*
|
|
3437
3467
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3438
3468
|
*
|
|
3439
|
-
* - `title`:
|
|
3440
|
-
* - `back`:
|
|
3441
|
-
* - `no-close`/`noClose`:
|
|
3442
|
-
* - `titleEl`: undefined (property only)
|
|
3443
|
-
* - `titleClasses`: undefined (property only) (readonly)
|
|
3444
|
-
* - `backButton`: undefined (property only) (readonly)
|
|
3445
|
-
* - `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
|
|
3446
3472
|
*
|
|
3447
3473
|
* ## Events
|
|
3448
3474
|
*
|
|
@@ -3455,31 +3481,25 @@ export type CustomElementsSolidJs = {
|
|
|
3455
3481
|
* Areas where markup can be added to the component.
|
|
3456
3482
|
*
|
|
3457
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.
|
|
3458
|
-
*
|
|
3459
|
-
* ## Methods
|
|
3460
|
-
*
|
|
3461
|
-
* Methods that can be called to access component functionality.
|
|
3462
|
-
*
|
|
3463
|
-
* - `emitBack() => void`: undefined
|
|
3464
|
-
* - `handleTopSlotChange(slotEvent) => void`: undefined
|
|
3465
3484
|
*/
|
|
3466
3485
|
"w-modal-header": Partial<
|
|
3467
|
-
|
|
3468
|
-
|
|
3469
|
-
BaseProps<
|
|
3486
|
+
WarpModalHeaderProps &
|
|
3487
|
+
WarpModalHeaderSolidJsProps &
|
|
3488
|
+
BaseProps<WarpModalHeader> &
|
|
3470
3489
|
BaseEvents
|
|
3471
3490
|
>;
|
|
3472
3491
|
|
|
3473
3492
|
/**
|
|
3474
3493
|
* A page indicator component that displays a series of dots representing pages.
|
|
3494
|
+
*
|
|
3475
3495
|
* One dot is highlighted to indicate the currently selected page.
|
|
3476
3496
|
*
|
|
3477
3497
|
* ## Attributes & Properties
|
|
3478
3498
|
*
|
|
3479
3499
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3480
3500
|
*
|
|
3481
|
-
* - `selected-page`/`selectedPage`: Currently selected page (1-based index
|
|
3482
|
-
* - `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
|
|
3483
3503
|
*/
|
|
3484
3504
|
"w-page-indicator": Partial<
|
|
3485
3505
|
WarpPageIndicatorProps &
|
|
@@ -3491,22 +3511,22 @@ export type CustomElementsSolidJs = {
|
|
|
3491
3511
|
/**
|
|
3492
3512
|
* Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.
|
|
3493
3513
|
*
|
|
3494
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/navigation-pagination--docs)
|
|
3495
|
-
*
|
|
3496
3514
|
* ## Attributes & Properties
|
|
3497
3515
|
*
|
|
3498
3516
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3499
3517
|
*
|
|
3500
|
-
* - `base-url`/`baseUrl`:
|
|
3501
|
-
*
|
|
3502
|
-
*
|
|
3503
|
-
* - `
|
|
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.
|
|
3504
3524
|
*
|
|
3505
3525
|
* ## Events
|
|
3506
3526
|
*
|
|
3507
3527
|
* Events that will be emitted by the component.
|
|
3508
3528
|
*
|
|
3509
|
-
* - `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.
|
|
3510
3530
|
*/
|
|
3511
3531
|
"w-pagination": Partial<
|
|
3512
3532
|
WarpPaginationProps &
|
|
@@ -3518,27 +3538,23 @@ export type CustomElementsSolidJs = {
|
|
|
3518
3538
|
/**
|
|
3519
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.
|
|
3520
3540
|
*
|
|
3521
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/buttons-pill--docs)
|
|
3522
|
-
*
|
|
3523
3541
|
* ## Attributes & Properties
|
|
3524
3542
|
*
|
|
3525
3543
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3526
3544
|
*
|
|
3527
|
-
* - `can-close`/`canClose`:
|
|
3528
|
-
* - `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.
|
|
3529
3547
|
* - `open-sr-label`/`openSrLabel`: undefined
|
|
3530
|
-
* - `open-aria-label`/`openAriaLabel`:
|
|
3548
|
+
* - `open-aria-label`/`openAriaLabel`: Label read by screen readers when targeting the pill.
|
|
3531
3549
|
* - `close-sr-label`/`closeSrLabel`: undefined
|
|
3532
|
-
* - `close-aria-label`/`closeAriaLabel`:
|
|
3533
|
-
* - `openFilterSrText`: undefined (property only)
|
|
3534
|
-
* - `removeFilterSrText`: undefined (property only)
|
|
3550
|
+
* - `close-aria-label`/`closeAriaLabel`: Label read by screen readers when targeting the close button.
|
|
3535
3551
|
*
|
|
3536
3552
|
* ## Events
|
|
3537
3553
|
*
|
|
3538
3554
|
* Events that will be emitted by the component.
|
|
3539
3555
|
*
|
|
3540
|
-
* - `w-pill-click`:
|
|
3541
|
-
* - `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.
|
|
3542
3558
|
*/
|
|
3543
3559
|
"w-pill": Partial<
|
|
3544
3560
|
WarpPillProps & WarpPillSolidJsProps & BaseProps<WarpPill> & BaseEvents
|