@warp-ds/elements 2.10.0 → 2.11.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 +59 -50
- package/dist/docs/affix/affix.md +1 -9
- package/dist/docs/alert/alert.md +1 -1
- package/dist/docs/attention/attention.md +3 -1
- package/dist/docs/box/box.md +2 -0
- package/dist/docs/breadcrumb-item/breadcrumb-item.md +2 -0
- package/dist/docs/breadcrumbs/breadcrumbs.md +3 -0
- package/dist/docs/button/button.md +3 -0
- package/dist/docs/card/api.md +0 -8
- package/dist/docs/card/card.md +58 -11
- package/dist/docs/card/styling.md +51 -0
- package/dist/docs/card/usage.md +4 -2
- package/dist/docs/checkbox/api.md +0 -9
- package/dist/docs/checkbox/checkbox.md +5 -10
- package/dist/docs/checkbox-group/checkbox-group.md +3 -10
- package/dist/docs/combobox/combobox.md +2 -0
- package/dist/docs/datepicker/datepicker.md +2 -2
- package/dist/docs/expandable/expandable.md +2 -0
- package/dist/docs/icon/icon.md +1 -1
- package/dist/docs/index.md +35 -35
- package/dist/docs/link/link.md +3 -1
- package/dist/docs/modal/modal.md +2 -0
- package/dist/docs/modal-footer/modal-footer.md +2 -0
- package/dist/docs/modal-header/modal-header.md +2 -0
- package/dist/docs/page-indicator/page-indicator.md +2 -0
- package/dist/docs/pagination/pagination.md +2 -0
- package/dist/docs/pill/pill.md +2 -0
- package/dist/docs/radio/radio.md +5 -1
- package/dist/docs/radio-group/radio-group.md +3 -1
- package/dist/docs/select/select.md +2 -0
- package/dist/docs/slider/slider.md +2 -0
- package/dist/docs/snackbar/snackbar.md +2 -0
- package/dist/docs/snackbar-item/snackbar-item.md +2 -0
- package/dist/docs/step/step.md +3 -1
- package/dist/docs/step-indicator/step-indicator.md +2 -0
- package/dist/docs/switch/switch.md +2 -0
- package/dist/docs/tab/tab.md +2 -0
- package/dist/docs/tab-panel/tab-panel.md +3 -0
- package/dist/docs/tabs/api.md +1 -1
- package/dist/docs/tabs/tabs.md +3 -1
- package/dist/docs/textarea/textarea.md +1 -5
- package/dist/docs/textfield/textfield.md +2 -0
- package/dist/entrypoint-react.d.ts +38 -0
- package/dist/entrypoint-react.js +39 -0
- package/dist/index.d.ts +152 -126
- package/dist/packages/affix/affix.d.ts +6 -11
- package/dist/packages/affix/affix.js +9 -9
- package/dist/packages/affix/affix.js.map +2 -2
- package/dist/packages/affix/affix.react.stories.d.ts +1 -1
- package/dist/packages/affix/react.d.ts +7 -2
- package/dist/packages/affix/react.js +5 -0
- package/dist/packages/alert/alert.d.ts +6 -3
- package/dist/packages/alert/alert.js +3 -3
- package/dist/packages/alert/alert.js.map +2 -2
- package/dist/packages/alert/react.d.ts +8 -1
- package/dist/packages/alert/react.js +7 -0
- package/dist/packages/attention/attention.d.ts +3 -1
- package/dist/packages/attention/attention.js +12 -12
- package/dist/packages/attention/attention.js.map +2 -2
- package/dist/packages/attention/react.d.ts +13 -3
- package/dist/packages/attention/react.js +9 -0
- package/dist/packages/badge/badge.d.ts +5 -0
- package/dist/packages/badge/badge.js.map +2 -2
- package/dist/packages/badge/react.d.ts +6 -1
- package/dist/packages/badge/react.js +5 -0
- package/dist/packages/box/box.d.ts +6 -1
- package/dist/packages/box/box.js +3 -3
- package/dist/packages/box/box.js.map +2 -2
- package/dist/packages/box/box.react.stories.d.ts +1 -1
- package/dist/packages/box/react.d.ts +6 -1
- package/dist/packages/box/react.js +5 -0
- package/dist/packages/breadcrumb-item/breadcrumb-item.d.ts +6 -1
- package/dist/packages/breadcrumb-item/breadcrumb-item.js +2 -2
- package/dist/packages/breadcrumb-item/breadcrumb-item.js.map +2 -2
- package/dist/packages/breadcrumb-item/react.d.ts +7 -1
- package/dist/packages/breadcrumb-item/react.js +6 -0
- package/dist/packages/breadcrumbs/breadcrumbs.d.ts +7 -1
- package/dist/packages/breadcrumbs/breadcrumbs.js +3 -3
- package/dist/packages/breadcrumbs/breadcrumbs.js.map +2 -2
- package/dist/packages/breadcrumbs/react.d.ts +8 -1
- package/dist/packages/breadcrumbs/react.js +7 -0
- package/dist/packages/button/button.d.ts +2 -1
- package/dist/packages/button/button.js.map +2 -2
- package/dist/packages/button/button.react.stories.d.ts +2 -2
- package/dist/packages/button/react.d.ts +9 -2
- package/dist/packages/button/react.js +7 -0
- package/dist/packages/card/card.d.ts +8 -10
- package/dist/packages/card/card.js +151 -20
- package/dist/packages/card/card.js.map +4 -4
- package/dist/packages/card/card.react.stories.d.ts +1 -1
- package/dist/packages/card/card.stories.d.ts +1 -0
- package/dist/packages/card/card.stories.js +44 -1
- package/dist/packages/card/react.d.ts +6 -1
- package/dist/packages/card/react.js +5 -0
- package/dist/packages/card/styles.js +132 -2
- package/dist/packages/checkbox/checkbox.d.ts +6 -0
- package/dist/packages/checkbox/checkbox.js +1 -1
- package/dist/packages/checkbox/checkbox.js.map +2 -2
- package/dist/packages/checkbox/checkbox.react.stories.d.ts +2 -2
- package/dist/packages/checkbox/react.d.ts +12 -3
- package/dist/packages/checkbox/react.js +7 -0
- package/dist/packages/checkbox-group/checkbox-group.d.ts +3 -10
- package/dist/packages/checkbox-group/checkbox-group.js.map +2 -2
- package/dist/packages/checkbox-group/react.d.ts +9 -2
- package/dist/packages/checkbox-group/react.js +7 -0
- package/dist/packages/combobox/combobox.d.ts +6 -1
- package/dist/packages/combobox/combobox.js +3 -3
- package/dist/packages/combobox/combobox.js.map +2 -2
- package/dist/packages/combobox/combobox.react.stories.d.ts +18 -2
- package/dist/packages/combobox/react.d.ts +15 -2
- package/dist/packages/combobox/react.js +9 -0
- package/dist/packages/datepicker/datepicker.d.ts +7 -4
- package/dist/packages/datepicker/datepicker.js +3 -3
- package/dist/packages/datepicker/datepicker.js.map +2 -2
- package/dist/packages/datepicker/datepicker.react.stories.d.ts +14 -14
- package/dist/packages/datepicker/react.d.ts +14 -8
- package/dist/packages/datepicker/react.js +5 -0
- package/dist/packages/expandable/expandable.d.ts +7 -0
- package/dist/packages/expandable/expandable.js +4 -4
- package/dist/packages/expandable/expandable.js.map +2 -2
- package/dist/packages/expandable/react.d.ts +6 -1
- package/dist/packages/expandable/react.js +5 -0
- package/dist/packages/icon/icon.d.ts +3 -0
- package/dist/packages/icon/icon.js.map +2 -2
- package/dist/packages/icon/react.d.ts +4 -1
- package/dist/packages/icon/react.js +3 -0
- package/dist/packages/link/link.d.ts +7 -2
- package/dist/packages/link/link.js +5 -5
- package/dist/packages/link/link.js.map +2 -2
- package/dist/packages/link/link.react.stories.d.ts +2 -2
- package/dist/packages/link/react.d.ts +7 -2
- package/dist/packages/link/react.js +5 -0
- package/dist/packages/modal/modal.d.ts +7 -0
- package/dist/packages/modal/modal.js +4 -4
- package/dist/packages/modal/modal.js.map +2 -2
- package/dist/packages/modal/react.d.ts +3 -1
- package/dist/packages/modal/react.js +2 -0
- package/dist/packages/modal-footer/modal-footer.d.ts +7 -0
- package/dist/packages/modal-footer/modal-footer.js +1 -1
- package/dist/packages/modal-footer/modal-footer.js.map +2 -2
- package/dist/packages/modal-footer/react.d.ts +6 -1
- package/dist/packages/modal-footer/react.js +5 -0
- package/dist/packages/modal-header/modal-header.d.ts +7 -0
- package/dist/packages/modal-header/modal-header.js +5 -5
- package/dist/packages/modal-header/modal-header.js.map +2 -2
- package/dist/packages/modal-header/react.d.ts +8 -3
- package/dist/packages/modal-header/react.js +5 -0
- package/dist/packages/page-indicator/page-indicator.d.ts +7 -0
- package/dist/packages/page-indicator/page-indicator.js +4 -4
- package/dist/packages/page-indicator/page-indicator.js.map +2 -2
- package/dist/packages/page-indicator/react.d.ts +8 -1
- package/dist/packages/page-indicator/react.js +7 -0
- package/dist/packages/pagination/pagination.d.ts +7 -0
- package/dist/packages/pagination/pagination.js +5 -5
- package/dist/packages/pagination/pagination.js.map +2 -2
- package/dist/packages/pagination/pagination.react.stories.d.ts +12 -4
- package/dist/packages/pagination/react.d.ts +12 -3
- package/dist/packages/pagination/react.js +5 -0
- package/dist/packages/pill/pill.d.ts +7 -0
- package/dist/packages/pill/pill.js.map +2 -2
- package/dist/packages/pill/pill.react.stories.d.ts +12 -8
- package/dist/packages/pill/pill.react.stories.js +4 -0
- package/dist/packages/pill/react.d.ts +10 -5
- package/dist/packages/pill/react.js +7 -2
- package/dist/packages/radio/radio.d.ts +6 -0
- package/dist/packages/radio/radio.js.map +2 -2
- package/dist/packages/radio/react.d.ts +8 -1
- package/dist/packages/radio/react.js +7 -0
- package/dist/packages/radio-group/radio-group.d.ts +3 -10
- package/dist/packages/radio-group/radio-group.js.map +2 -2
- package/dist/packages/radio-group/react.d.ts +11 -4
- package/dist/packages/radio-group/react.js +8 -0
- package/dist/packages/select/react.d.ts +10 -4
- package/dist/packages/select/react.js +5 -0
- package/dist/packages/select/select.d.ts +8 -2
- package/dist/packages/select/select.js +5 -5
- package/dist/packages/select/select.js.map +2 -2
- package/dist/packages/select/select.react.stories.d.ts +6 -6
- package/dist/packages/select/select.react.stories.js +4 -4
- package/dist/packages/slider/react.d.ts +7 -2
- package/dist/packages/slider/react.js +5 -0
- package/dist/packages/slider/slider.d.ts +7 -0
- package/dist/packages/slider/slider.js +6 -6
- package/dist/packages/slider/slider.js.map +2 -2
- package/dist/packages/slider/slider.react.stories.d.ts +1 -1
- package/dist/packages/slider-thumb/react.d.ts +15 -4
- package/dist/packages/slider-thumb/react.js +5 -0
- package/dist/packages/slider-thumb/slider-thumb.d.ts +5 -0
- package/dist/packages/slider-thumb/slider-thumb.js +4 -4
- package/dist/packages/slider-thumb/slider-thumb.js.map +2 -2
- package/dist/packages/snackbar/react.d.ts +40 -1
- package/dist/packages/snackbar/react.js +39 -0
- package/dist/packages/snackbar/snackbar.d.ts +2 -0
- package/dist/packages/snackbar/snackbar.js.map +2 -2
- package/dist/packages/snackbar-item/react.d.ts +8 -1
- package/dist/packages/snackbar-item/react.js +7 -0
- package/dist/packages/snackbar-item/snackbar-item.d.ts +2 -0
- package/dist/packages/snackbar-item/snackbar-item.js.map +2 -2
- package/dist/packages/step/react.d.ts +6 -1
- package/dist/packages/step/react.js +5 -0
- package/dist/packages/step/step.d.ts +8 -1
- package/dist/packages/step/step.js +7 -7
- package/dist/packages/step/step.js.map +2 -2
- package/dist/packages/step-indicator/react.d.ts +6 -1
- package/dist/packages/step-indicator/react.js +5 -0
- package/dist/packages/step-indicator/step-indicator.d.ts +7 -0
- package/dist/packages/step-indicator/step-indicator.js +2 -2
- package/dist/packages/step-indicator/step-indicator.js.map +2 -2
- package/dist/packages/switch/react.d.ts +9 -3
- package/dist/packages/switch/react.js +5 -0
- package/dist/packages/switch/switch.d.ts +7 -0
- package/dist/packages/switch/switch.js +3 -3
- package/dist/packages/switch/switch.js.map +2 -2
- package/dist/packages/switch/switch.react.stories.d.ts +2 -2
- package/dist/packages/tab/react.d.ts +9 -6
- package/dist/packages/tab/react.js +5 -2
- package/dist/packages/tab/tab.d.ts +7 -0
- package/dist/packages/tab/tab.js.map +2 -2
- package/dist/packages/tab-panel/react.d.ts +8 -1
- package/dist/packages/tab-panel/react.js +7 -0
- package/dist/packages/tab-panel/tab-panel.d.ts +3 -0
- package/dist/packages/tab-panel/tab-panel.js.map +2 -2
- package/dist/packages/tabs/react.d.ts +7 -3
- package/dist/packages/tabs/react.js +6 -2
- package/dist/packages/tabs/tabs.d.ts +3 -1
- package/dist/packages/tabs/tabs.js.map +2 -2
- package/dist/packages/textarea/react.d.ts +16 -10
- package/dist/packages/textarea/react.js +5 -0
- package/dist/packages/textarea/textarea.d.ts +6 -5
- package/dist/packages/textarea/textarea.js +5 -5
- package/dist/packages/textarea/textarea.js.map +2 -2
- package/dist/packages/textarea/textarea.react.stories.d.ts +18 -18
- package/dist/packages/textfield/react.d.ts +16 -10
- package/dist/packages/textfield/react.js +5 -0
- package/dist/packages/textfield/react.test.d.ts +1 -0
- package/dist/packages/textfield/react.test.js +20 -0
- package/dist/packages/textfield/textfield.d.ts +7 -5
- package/dist/packages/textfield/textfield.js +8 -8
- package/dist/packages/textfield/textfield.js.map +3 -3
- package/dist/packages/textfield/textfield.react.stories.d.ts +18 -18
- package/dist/packages/toast/toast.d.ts +5 -0
- package/dist/packages/toast/toast.js +4 -4
- package/dist/packages/toast/toast.js.map +2 -2
- package/dist/packages/toast-container/toast-container.d.ts +6 -1
- package/dist/packages/toast-container/toast-container.js +3 -3
- package/dist/packages/toast-container/toast-container.js.map +2 -2
- package/dist/packages/types.d.ts +16 -0
- package/dist/packages/types.js +1 -0
- package/dist/web-types.json +43 -44
- package/eik/index.js +14 -14
- package/package.json +4 -112
- package/dist/packages/slider/Slider.d.ts +0 -2
- package/dist/packages/slider/Slider.js +0 -8
- package/dist/packages/slider-thumb/SliderThumb.d.ts +0 -2
- package/dist/packages/slider-thumb/SliderThumb.js +0 -8
package/dist/index.d.ts
CHANGED
|
@@ -903,8 +903,6 @@ Flat cards use a bordered surface instead of the default elevated surface. Use t
|
|
|
903
903
|
|
|
904
904
|
When set, the card becomes keyboard focusable and Enter or Space triggers a click on the card. Use this only when the whole card has one action or represents one selectable choice. */
|
|
905
905
|
clickable?: WarpCard["clickable"];
|
|
906
|
-
/** */
|
|
907
|
-
buttonText?: WarpCard["buttonText"];
|
|
908
906
|
};
|
|
909
907
|
|
|
910
908
|
export type WarpCardSolidJsProps = {
|
|
@@ -920,8 +918,6 @@ Flat cards use a bordered surface instead of the default elevated surface. Use t
|
|
|
920
918
|
|
|
921
919
|
When set, the card becomes keyboard focusable and Enter or Space triggers a click on the card. Use this only when the whole card has one action or represents one selectable choice. */
|
|
922
920
|
"prop:clickable"?: WarpCard["clickable"];
|
|
923
|
-
/** */
|
|
924
|
-
"prop:buttonText"?: WarpCard["buttonText"];
|
|
925
921
|
|
|
926
922
|
/** Set the innerHTML of the element */
|
|
927
923
|
innerHTML?: string;
|
|
@@ -929,9 +925,6 @@ When set, the card becomes keyboard focusable and Enter or Space triggers a clic
|
|
|
929
925
|
textContent?: string | number;
|
|
930
926
|
};
|
|
931
927
|
|
|
932
|
-
/** `WarpCheckbox` component event */
|
|
933
|
-
export type WarpCheckboxElementEvent<E = Event> = TypedEvent<WarpCheckbox, E>;
|
|
934
|
-
|
|
935
928
|
export type WarpCheckboxProps = {
|
|
936
929
|
/** The name of the checkbox.
|
|
937
930
|
|
|
@@ -963,9 +956,6 @@ Use this to show an externally managed validation error. Required validation als
|
|
|
963
956
|
invalid?: WarpCheckbox["invalid"];
|
|
964
957
|
/** */
|
|
965
958
|
input?: WarpCheckbox["input"];
|
|
966
|
-
|
|
967
|
-
/** */
|
|
968
|
-
onchange?: (e: WarpCheckboxElementEvent) => void;
|
|
969
959
|
};
|
|
970
960
|
|
|
971
961
|
export type WarpCheckboxSolidJsProps = {
|
|
@@ -999,8 +989,6 @@ Use this to show an externally managed validation error. Required validation als
|
|
|
999
989
|
"prop:invalid"?: WarpCheckbox["invalid"];
|
|
1000
990
|
/** */
|
|
1001
991
|
"prop:input"?: WarpCheckbox["input"];
|
|
1002
|
-
/** */
|
|
1003
|
-
"on:change"?: (e: WarpCheckboxElementEvent) => void;
|
|
1004
992
|
|
|
1005
993
|
/** Set the innerHTML of the element */
|
|
1006
994
|
innerHTML?: string;
|
|
@@ -2204,14 +2192,14 @@ export type WarpTabsProps = {
|
|
|
2204
2192
|
/** The `id` of the panel that should be active. */
|
|
2205
2193
|
active?: WarpTabs["active"];
|
|
2206
2194
|
|
|
2207
|
-
/** Includes `details.panelId` with the now active tab's ID */
|
|
2195
|
+
/** Includes `details.panelId` with the now active tab panel's ID */
|
|
2208
2196
|
onchange?: (e: WarpTabsChangeElementEvent) => void;
|
|
2209
2197
|
};
|
|
2210
2198
|
|
|
2211
2199
|
export type WarpTabsSolidJsProps = {
|
|
2212
2200
|
/** The `id` of the panel that should be active. */
|
|
2213
2201
|
"prop:active"?: WarpTabs["active"];
|
|
2214
|
-
/** Includes `details.panelId` with the now active tab's ID */
|
|
2202
|
+
/** Includes `details.panelId` with the now active tab panel's ID */
|
|
2215
2203
|
"on:change"?: (e: WarpTabsChangeElementEvent) => void;
|
|
2216
2204
|
|
|
2217
2205
|
/** Set the innerHTML of the element */
|
|
@@ -2323,6 +2311,8 @@ export type CustomElements = {
|
|
|
2323
2311
|
/**
|
|
2324
2312
|
* A single-line input component used for entering and editing textual or numeric data.
|
|
2325
2313
|
*
|
|
2314
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/text-area/frameworks/elements)
|
|
2315
|
+
*
|
|
2326
2316
|
* ## Attributes & Properties
|
|
2327
2317
|
*
|
|
2328
2318
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -2369,7 +2359,7 @@ export type CustomElements = {
|
|
|
2369
2359
|
* Areas where markup can be added to the component.
|
|
2370
2360
|
*
|
|
2371
2361
|
* - `suffix`: Use with `<w-affix>` to include a suffix, for example the unit for a number (e. g. km or sek).
|
|
2372
|
-
* - `prefix`: Use with `<w-affix>` to include a prefix, for example a search icon.
|
|
2362
|
+
* - `prefix`: Use with `<w-affix>` to include a prefix, for example a search icon.
|
|
2373
2363
|
*
|
|
2374
2364
|
* ## Methods
|
|
2375
2365
|
*
|
|
@@ -2385,7 +2375,7 @@ export type CustomElements = {
|
|
|
2385
2375
|
>;
|
|
2386
2376
|
|
|
2387
2377
|
/**
|
|
2388
|
-
*
|
|
2378
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/icons/frameworks/elements)
|
|
2389
2379
|
*
|
|
2390
2380
|
* ## Attributes & Properties
|
|
2391
2381
|
*
|
|
@@ -2402,17 +2392,7 @@ export type CustomElements = {
|
|
|
2402
2392
|
/**
|
|
2403
2393
|
* This component is usually used in other components like form elements to show a prefix or suffix. See for example `w-textfield`.
|
|
2404
2394
|
*
|
|
2405
|
-
*
|
|
2406
|
-
* Due to shadow DOM encapsulation, ARIA attributes (like `aria-describedby`, `aria-labelledby`)
|
|
2407
|
-
* cannot reference elements across shadow boundaries. This means:
|
|
2408
|
-
* - Non-interactive affixes (text labels, icons) cannot be connected to the parent input via ARIA
|
|
2409
|
-
* - Interactive affixes (buttons) must have their own `aria-label` (already implemented)
|
|
2410
|
-
* - Do NOT attempt to reference affix content from parent components via ARIA ID references - it won't work
|
|
2411
|
-
*
|
|
2412
|
-
* For non-interactive labels (e.g., currency symbols), consider including the information in the
|
|
2413
|
-
* main label or placeholder instead of relying on ARIA to announce affix content.
|
|
2414
|
-
*
|
|
2415
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/forms-affix--docs)
|
|
2395
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/text-field/frameworks/elements#prefix-label)
|
|
2416
2396
|
*
|
|
2417
2397
|
* ## Attributes & Properties
|
|
2418
2398
|
*
|
|
@@ -2432,9 +2412,7 @@ export type CustomElements = {
|
|
|
2432
2412
|
/**
|
|
2433
2413
|
* Alert is an inline component used for displaying different types of messages.
|
|
2434
2414
|
*
|
|
2435
|
-
*
|
|
2436
|
-
*
|
|
2437
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/feedback-alert--docs)
|
|
2415
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/alert/frameworks/elements)
|
|
2438
2416
|
*
|
|
2439
2417
|
* ## Attributes & Properties
|
|
2440
2418
|
*
|
|
@@ -2447,9 +2425,9 @@ export type CustomElements = {
|
|
|
2447
2425
|
"w-alert": Partial<WarpAlertProps & BaseProps<WarpAlert> & BaseEvents>;
|
|
2448
2426
|
|
|
2449
2427
|
/**
|
|
2450
|
-
*
|
|
2428
|
+
* Link component to use when creating links that look like buttons.
|
|
2451
2429
|
*
|
|
2452
|
-
* [
|
|
2430
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/link/frameworks/elements)
|
|
2453
2431
|
*
|
|
2454
2432
|
* ## Attributes & Properties
|
|
2455
2433
|
*
|
|
@@ -2472,9 +2450,10 @@ export type CustomElements = {
|
|
|
2472
2450
|
|
|
2473
2451
|
/**
|
|
2474
2452
|
* Performs an action or renders a link with button styling.
|
|
2453
|
+
*
|
|
2475
2454
|
* Use button variants to match action priority, risk, and context.
|
|
2476
2455
|
*
|
|
2477
|
-
* [
|
|
2456
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/button/frameworks/elements)
|
|
2478
2457
|
*
|
|
2479
2458
|
* ## Attributes & Properties
|
|
2480
2459
|
*
|
|
@@ -2522,11 +2501,13 @@ export type CustomElements = {
|
|
|
2522
2501
|
"w-button": Partial<WarpButtonProps & BaseProps<WarpButton> & BaseEvents>;
|
|
2523
2502
|
|
|
2524
2503
|
/**
|
|
2504
|
+
* Note: attention will soon be split into multiple components (tooltip, callout, popover, highlight) at which time this component will be deprecated. For now, use the `tooltip`, `callout`, `popover`, and `highlight` boolean properties to achieve the desired style and behavior.
|
|
2505
|
+
*
|
|
2525
2506
|
* Attention is a versatile component for displaying contextual information and messages. It can be used for a wide range of purposes, such as tooltips, callouts, popovers, and highlights.
|
|
2526
2507
|
*
|
|
2527
2508
|
* The component is designed to be anchored to a trigger element, providing contextual information related to that element. It supports various placements and styling options to accommodate different use cases and design needs.
|
|
2528
2509
|
*
|
|
2529
|
-
*
|
|
2510
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/tooltip/frameworks/elements)
|
|
2530
2511
|
*
|
|
2531
2512
|
* ## Attributes & Properties
|
|
2532
2513
|
*
|
|
@@ -2601,7 +2582,7 @@ export type CustomElements = {
|
|
|
2601
2582
|
/**
|
|
2602
2583
|
* Box is a layout component used for separating content areas on a page.
|
|
2603
2584
|
*
|
|
2604
|
-
* [
|
|
2585
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/box/frameworks/elements)
|
|
2605
2586
|
*
|
|
2606
2587
|
* ## Attributes & Properties
|
|
2607
2588
|
*
|
|
@@ -2622,9 +2603,10 @@ export type CustomElements = {
|
|
|
2622
2603
|
|
|
2623
2604
|
/**
|
|
2624
2605
|
* Shows the navigation structure for the current page.
|
|
2606
|
+
*
|
|
2625
2607
|
* Renders direct child links and non-link elements as a breadcrumb trail, inserts separators between items, and exposes the trail as navigation.
|
|
2626
2608
|
*
|
|
2627
|
-
* [
|
|
2609
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)
|
|
2628
2610
|
*
|
|
2629
2611
|
* ## Attributes & Properties
|
|
2630
2612
|
*
|
|
@@ -2641,7 +2623,7 @@ export type CustomElements = {
|
|
|
2641
2623
|
* Represents one item in a `w-breadcrumbs` trail.
|
|
2642
2624
|
* Renders the slotted label as a link when `href` is set, or as text when it is not, and adds a separator after non-current items.
|
|
2643
2625
|
*
|
|
2644
|
-
* [
|
|
2626
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)
|
|
2645
2627
|
*
|
|
2646
2628
|
* ## Attributes & Properties
|
|
2647
2629
|
*
|
|
@@ -2663,9 +2645,9 @@ export type CustomElements = {
|
|
|
2663
2645
|
>;
|
|
2664
2646
|
|
|
2665
2647
|
/**
|
|
2666
|
-
* Card is a layout component used for
|
|
2648
|
+
* Card is a layout component used for grouping interactive content areas on a page.
|
|
2667
2649
|
*
|
|
2668
|
-
* [
|
|
2650
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/card/frameworks/elements)
|
|
2669
2651
|
*
|
|
2670
2652
|
* ## Attributes & Properties
|
|
2671
2653
|
*
|
|
@@ -2680,7 +2662,6 @@ export type CustomElements = {
|
|
|
2680
2662
|
* - `clickable`: Whether the whole card is interactive.
|
|
2681
2663
|
*
|
|
2682
2664
|
* When set, the card becomes keyboard focusable and Enter or Space triggers a click on the card. Use this only when the whole card has one action or represents one selectable choice.
|
|
2683
|
-
* - `buttonText`: undefined (property only)
|
|
2684
2665
|
*
|
|
2685
2666
|
* ## Methods
|
|
2686
2667
|
*
|
|
@@ -2691,7 +2672,11 @@ export type CustomElements = {
|
|
|
2691
2672
|
"w-card": Partial<WarpCardProps & BaseProps<WarpCard> & BaseEvents>;
|
|
2692
2673
|
|
|
2693
2674
|
/**
|
|
2675
|
+
* Checkboxes allow users to select one or more options from a number of choices.
|
|
2676
|
+
*
|
|
2677
|
+
* Wrap individual checkboxes in a checkbox group.
|
|
2694
2678
|
*
|
|
2679
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/checkbox/frameworks/elements)
|
|
2695
2680
|
*
|
|
2696
2681
|
* ## Attributes & Properties
|
|
2697
2682
|
*
|
|
@@ -2723,12 +2708,6 @@ export type CustomElements = {
|
|
|
2723
2708
|
* - `validationMessage`: Returns the validation message if the checkbox is invalid, otherwise an empty string (property only) (readonly)
|
|
2724
2709
|
* - `validity`: Returns the validity state of the checkbox (property only) (readonly)
|
|
2725
2710
|
*
|
|
2726
|
-
* ## Events
|
|
2727
|
-
*
|
|
2728
|
-
* Events that will be emitted by the component.
|
|
2729
|
-
*
|
|
2730
|
-
* - `change`: undefined
|
|
2731
|
-
*
|
|
2732
2711
|
* ## Methods
|
|
2733
2712
|
*
|
|
2734
2713
|
* Methods that can be called to access component functionality.
|
|
@@ -2745,18 +2724,11 @@ export type CustomElements = {
|
|
|
2745
2724
|
>;
|
|
2746
2725
|
|
|
2747
2726
|
/**
|
|
2748
|
-
* Checkboxes allow users to select
|
|
2749
|
-
*
|
|
2750
|
-
* Use with `w-checkbox`.
|
|
2727
|
+
* Checkboxes allow users to select one or more options from a number of choices.
|
|
2751
2728
|
*
|
|
2752
|
-
*
|
|
2753
|
-
* This component uses a <div> wrapper instead of the more semantic <fieldset> element.
|
|
2754
|
-
* Note that w-radio-group uses <fieldset>, which provides better accessibility and follows
|
|
2755
|
-
* HTML best practices. This inconsistency exists for historical reasons and may be addressed
|
|
2756
|
-
* in a future major version to align both on the more semantic approach.
|
|
2729
|
+
* Wrap individual checkboxes in a checkbox group.
|
|
2757
2730
|
*
|
|
2758
|
-
*
|
|
2759
|
-
* backwards compatibility implications (CSS selectors, etc.).
|
|
2731
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/checkbox/frameworks/elements)
|
|
2760
2732
|
*
|
|
2761
2733
|
* ## Attributes & Properties
|
|
2762
2734
|
*
|
|
@@ -2796,7 +2768,7 @@ export type CustomElements = {
|
|
|
2796
2768
|
/**
|
|
2797
2769
|
* A combobox element for text input with selectable options.
|
|
2798
2770
|
*
|
|
2799
|
-
* [
|
|
2771
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/combo-box/frameworks/elements)
|
|
2800
2772
|
*
|
|
2801
2773
|
* ## Attributes & Properties
|
|
2802
2774
|
*
|
|
@@ -2859,11 +2831,9 @@ export type CustomElements = {
|
|
|
2859
2831
|
>;
|
|
2860
2832
|
|
|
2861
2833
|
/**
|
|
2862
|
-
*
|
|
2863
|
-
*
|
|
2864
|
-
* Uses the `lang` attribute on either the element or on `<html>` to determine the locale options.
|
|
2834
|
+
* A date picker allows the user to select a specific calendar date.
|
|
2865
2835
|
*
|
|
2866
|
-
* [
|
|
2836
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/date-picker/frameworks/elements)
|
|
2867
2837
|
*
|
|
2868
2838
|
* ## Attributes & Properties
|
|
2869
2839
|
*
|
|
@@ -2923,6 +2893,8 @@ export type CustomElements = {
|
|
|
2923
2893
|
/**
|
|
2924
2894
|
* Expandable is a layout component used for creating expandable content areas on a page.
|
|
2925
2895
|
*
|
|
2896
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/expandable/frameworks/elements)
|
|
2897
|
+
*
|
|
2926
2898
|
* ## Attributes & Properties
|
|
2927
2899
|
*
|
|
2928
2900
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -2952,6 +2924,8 @@ export type CustomElements = {
|
|
|
2952
2924
|
/**
|
|
2953
2925
|
* Modals (or dialogs) display important information that users need to acknowledge.
|
|
2954
2926
|
*
|
|
2927
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)
|
|
2928
|
+
*
|
|
2955
2929
|
* ## Attributes & Properties
|
|
2956
2930
|
*
|
|
2957
2931
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3011,6 +2985,8 @@ export type CustomElements = {
|
|
|
3011
2985
|
/**
|
|
3012
2986
|
* The footer section of a modal, typically where you place actions.
|
|
3013
2987
|
*
|
|
2988
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)
|
|
2989
|
+
*
|
|
3014
2990
|
* ## CSS Custom Properties
|
|
3015
2991
|
*
|
|
3016
2992
|
* CSS variables available for styling the component.
|
|
@@ -3030,6 +3006,8 @@ export type CustomElements = {
|
|
|
3030
3006
|
/**
|
|
3031
3007
|
* The header section of a modal, typically where you place the title and a close button.
|
|
3032
3008
|
*
|
|
3009
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)
|
|
3010
|
+
*
|
|
3033
3011
|
* ## Attributes & Properties
|
|
3034
3012
|
*
|
|
3035
3013
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3077,6 +3055,8 @@ export type CustomElements = {
|
|
|
3077
3055
|
*
|
|
3078
3056
|
* One dot is highlighted to indicate the currently selected page.
|
|
3079
3057
|
*
|
|
3058
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/page-indicator/frameworks/elements)
|
|
3059
|
+
*
|
|
3080
3060
|
* ## Attributes & Properties
|
|
3081
3061
|
*
|
|
3082
3062
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3091,6 +3071,8 @@ export type CustomElements = {
|
|
|
3091
3071
|
/**
|
|
3092
3072
|
* Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.
|
|
3093
3073
|
*
|
|
3074
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/pagination/frameworks/elements)
|
|
3075
|
+
*
|
|
3094
3076
|
* ## Attributes & Properties
|
|
3095
3077
|
*
|
|
3096
3078
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3115,6 +3097,8 @@ export type CustomElements = {
|
|
|
3115
3097
|
/**
|
|
3116
3098
|
* 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.
|
|
3117
3099
|
*
|
|
3100
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/pill/frameworks/elements)
|
|
3101
|
+
*
|
|
3118
3102
|
* ## Attributes & Properties
|
|
3119
3103
|
*
|
|
3120
3104
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3136,7 +3120,11 @@ export type CustomElements = {
|
|
|
3136
3120
|
"w-pill": Partial<WarpPillProps & BaseProps<WarpPill> & BaseEvents>;
|
|
3137
3121
|
|
|
3138
3122
|
/**
|
|
3123
|
+
* Radios allow users to select a single option from a list of choices.
|
|
3139
3124
|
*
|
|
3125
|
+
* Wrap individual radio components in a radio group.
|
|
3126
|
+
*
|
|
3127
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/radio/frameworks/elements)
|
|
3140
3128
|
*
|
|
3141
3129
|
* ## Attributes & Properties
|
|
3142
3130
|
*
|
|
@@ -3154,7 +3142,9 @@ export type CustomElements = {
|
|
|
3154
3142
|
/**
|
|
3155
3143
|
* Radios allow users to select a single option from a list of choices.
|
|
3156
3144
|
*
|
|
3157
|
-
*
|
|
3145
|
+
* Wrap individual radio components in a radio group.
|
|
3146
|
+
*
|
|
3147
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/radio/frameworks/elements)
|
|
3158
3148
|
*
|
|
3159
3149
|
* ## Attributes & Properties
|
|
3160
3150
|
*
|
|
@@ -3175,7 +3165,7 @@ export type CustomElements = {
|
|
|
3175
3165
|
* Areas where markup can be added to the component.
|
|
3176
3166
|
*
|
|
3177
3167
|
* - `label`: Alternative to the `label` attribute should you need custom HTML.
|
|
3178
|
-
* - `help-text`: Alternative to the `help-text` attribute should you need custom HTML.
|
|
3168
|
+
* - `help-text`: Alternative to the `help-text` attribute should you need custom HTML.
|
|
3179
3169
|
*/
|
|
3180
3170
|
"w-radio-group": Partial<
|
|
3181
3171
|
WarpRadioGroupProps & BaseProps<WarpRadioGroup> & BaseEvents
|
|
@@ -3184,6 +3174,8 @@ export type CustomElements = {
|
|
|
3184
3174
|
/**
|
|
3185
3175
|
* A dropdown component for selecting a single value.
|
|
3186
3176
|
*
|
|
3177
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/select/frameworks/elements)
|
|
3178
|
+
*
|
|
3187
3179
|
* ## Attributes & Properties
|
|
3188
3180
|
*
|
|
3189
3181
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3248,6 +3240,8 @@ export type CustomElements = {
|
|
|
3248
3240
|
/**
|
|
3249
3241
|
* Parent component for sliders (both single and range sliders). Used in combination with a `<w-slider-thumb>`.
|
|
3250
3242
|
*
|
|
3243
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/slider/frameworks/elements)
|
|
3244
|
+
*
|
|
3251
3245
|
* ## Attributes & Properties
|
|
3252
3246
|
*
|
|
3253
3247
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3292,6 +3286,8 @@ export type CustomElements = {
|
|
|
3292
3286
|
*
|
|
3293
3287
|
* See the `create` function on `w-snackbar` for a convenience API which helps you make snackbar items.
|
|
3294
3288
|
*
|
|
3289
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/snackbar/frameworks/elements)
|
|
3290
|
+
*
|
|
3295
3291
|
* ## Attributes & Properties
|
|
3296
3292
|
*
|
|
3297
3293
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3349,6 +3345,8 @@ export type CustomElements = {
|
|
|
3349
3345
|
*
|
|
3350
3346
|
* Include one `<w-snackbar></w-snackbar>` in the document `<body>`. Use the `create` function to create messages.
|
|
3351
3347
|
*
|
|
3348
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/snackbar/frameworks/elements)
|
|
3349
|
+
*
|
|
3352
3350
|
* ## Slots
|
|
3353
3351
|
*
|
|
3354
3352
|
* Areas where markup can be added to the component.
|
|
@@ -3394,7 +3392,9 @@ export type CustomElements = {
|
|
|
3394
3392
|
>;
|
|
3395
3393
|
|
|
3396
3394
|
/**
|
|
3397
|
-
* Individual step component that shows a single step in a process
|
|
3395
|
+
* Individual step component that shows a single step in a process.
|
|
3396
|
+
*
|
|
3397
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/steps/frameworks/elements)
|
|
3398
3398
|
*
|
|
3399
3399
|
* ## Attributes & Properties
|
|
3400
3400
|
*
|
|
@@ -3419,6 +3419,8 @@ export type CustomElements = {
|
|
|
3419
3419
|
/**
|
|
3420
3420
|
* Steps are used to show progress through a process or to guide users through a multi-step task.
|
|
3421
3421
|
*
|
|
3422
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/steps/frameworks/elements)
|
|
3423
|
+
*
|
|
3422
3424
|
* ## Attributes & Properties
|
|
3423
3425
|
*
|
|
3424
3426
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3433,6 +3435,8 @@ export type CustomElements = {
|
|
|
3433
3435
|
/**
|
|
3434
3436
|
* The Switch component allows users to toggle between two states.
|
|
3435
3437
|
*
|
|
3438
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/switch/frameworks/elements)
|
|
3439
|
+
*
|
|
3436
3440
|
* ## Attributes & Properties
|
|
3437
3441
|
*
|
|
3438
3442
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3461,6 +3465,8 @@ export type CustomElements = {
|
|
|
3461
3465
|
/**
|
|
3462
3466
|
* Individual tab component used within w-tabs container.
|
|
3463
3467
|
*
|
|
3468
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)
|
|
3469
|
+
*
|
|
3464
3470
|
* ## Attributes & Properties
|
|
3465
3471
|
*
|
|
3466
3472
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3472,8 +3478,11 @@ export type CustomElements = {
|
|
|
3472
3478
|
|
|
3473
3479
|
/**
|
|
3474
3480
|
* Tab panel component that holds content for individual tabs.
|
|
3481
|
+
*
|
|
3475
3482
|
* Each tab panel should have a name that matches a corresponding tab.
|
|
3476
3483
|
*
|
|
3484
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)
|
|
3485
|
+
*
|
|
3477
3486
|
* ## Attributes & Properties
|
|
3478
3487
|
*
|
|
3479
3488
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3487,6 +3496,8 @@ export type CustomElements = {
|
|
|
3487
3496
|
/**
|
|
3488
3497
|
* Tabs are used to organize content by grouping similar information on the same page.
|
|
3489
3498
|
*
|
|
3499
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)
|
|
3500
|
+
*
|
|
3490
3501
|
* ## Attributes & Properties
|
|
3491
3502
|
*
|
|
3492
3503
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3497,18 +3508,14 @@ export type CustomElements = {
|
|
|
3497
3508
|
*
|
|
3498
3509
|
* Events that will be emitted by the component.
|
|
3499
3510
|
*
|
|
3500
|
-
* - `change`: Includes `details.panelId` with the now active tab's ID
|
|
3511
|
+
* - `change`: Includes `details.panelId` with the now active tab panel's ID
|
|
3501
3512
|
*/
|
|
3502
3513
|
"w-tabs": Partial<WarpTabsProps & BaseProps<WarpTabs> & BaseEvents>;
|
|
3503
3514
|
|
|
3504
3515
|
/**
|
|
3505
3516
|
* A multi-line text input with built-in form validation, auto-resizing, and styling support.
|
|
3506
3517
|
*
|
|
3507
|
-
*
|
|
3508
|
-
* - Form integration
|
|
3509
|
-
* - Auto-resizing based on content and row constraints
|
|
3510
|
-
* - Built-in validation with customizable error messages
|
|
3511
|
-
* - Accessibility attributes and labeling
|
|
3518
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/text-area/frameworks/elements)
|
|
3512
3519
|
*
|
|
3513
3520
|
* ## Attributes & Properties
|
|
3514
3521
|
*
|
|
@@ -3664,6 +3671,8 @@ export type CustomElementsSolidJs = {
|
|
|
3664
3671
|
/**
|
|
3665
3672
|
* A single-line input component used for entering and editing textual or numeric data.
|
|
3666
3673
|
*
|
|
3674
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/text-area/frameworks/elements)
|
|
3675
|
+
*
|
|
3667
3676
|
* ## Attributes & Properties
|
|
3668
3677
|
*
|
|
3669
3678
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -3710,7 +3719,7 @@ export type CustomElementsSolidJs = {
|
|
|
3710
3719
|
* Areas where markup can be added to the component.
|
|
3711
3720
|
*
|
|
3712
3721
|
* - `suffix`: Use with `<w-affix>` to include a suffix, for example the unit for a number (e. g. km or sek).
|
|
3713
|
-
* - `prefix`: Use with `<w-affix>` to include a prefix, for example a search icon.
|
|
3722
|
+
* - `prefix`: Use with `<w-affix>` to include a prefix, for example a search icon.
|
|
3714
3723
|
*
|
|
3715
3724
|
* ## Methods
|
|
3716
3725
|
*
|
|
@@ -3729,7 +3738,7 @@ export type CustomElementsSolidJs = {
|
|
|
3729
3738
|
>;
|
|
3730
3739
|
|
|
3731
3740
|
/**
|
|
3732
|
-
*
|
|
3741
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/icons/frameworks/elements)
|
|
3733
3742
|
*
|
|
3734
3743
|
* ## Attributes & Properties
|
|
3735
3744
|
*
|
|
@@ -3748,17 +3757,7 @@ export type CustomElementsSolidJs = {
|
|
|
3748
3757
|
/**
|
|
3749
3758
|
* This component is usually used in other components like form elements to show a prefix or suffix. See for example `w-textfield`.
|
|
3750
3759
|
*
|
|
3751
|
-
*
|
|
3752
|
-
* Due to shadow DOM encapsulation, ARIA attributes (like `aria-describedby`, `aria-labelledby`)
|
|
3753
|
-
* cannot reference elements across shadow boundaries. This means:
|
|
3754
|
-
* - Non-interactive affixes (text labels, icons) cannot be connected to the parent input via ARIA
|
|
3755
|
-
* - Interactive affixes (buttons) must have their own `aria-label` (already implemented)
|
|
3756
|
-
* - Do NOT attempt to reference affix content from parent components via ARIA ID references - it won't work
|
|
3757
|
-
*
|
|
3758
|
-
* For non-interactive labels (e.g., currency symbols), consider including the information in the
|
|
3759
|
-
* main label or placeholder instead of relying on ARIA to announce affix content.
|
|
3760
|
-
*
|
|
3761
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/forms-affix--docs)
|
|
3760
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/text-field/frameworks/elements#prefix-label)
|
|
3762
3761
|
*
|
|
3763
3762
|
* ## Attributes & Properties
|
|
3764
3763
|
*
|
|
@@ -3780,9 +3779,7 @@ export type CustomElementsSolidJs = {
|
|
|
3780
3779
|
/**
|
|
3781
3780
|
* Alert is an inline component used for displaying different types of messages.
|
|
3782
3781
|
*
|
|
3783
|
-
*
|
|
3784
|
-
*
|
|
3785
|
-
* [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/feedback-alert--docs)
|
|
3782
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/alert/frameworks/elements)
|
|
3786
3783
|
*
|
|
3787
3784
|
* ## Attributes & Properties
|
|
3788
3785
|
*
|
|
@@ -3797,9 +3794,9 @@ export type CustomElementsSolidJs = {
|
|
|
3797
3794
|
>;
|
|
3798
3795
|
|
|
3799
3796
|
/**
|
|
3800
|
-
*
|
|
3797
|
+
* Link component to use when creating links that look like buttons.
|
|
3801
3798
|
*
|
|
3802
|
-
* [
|
|
3799
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/link/frameworks/elements)
|
|
3803
3800
|
*
|
|
3804
3801
|
* ## Attributes & Properties
|
|
3805
3802
|
*
|
|
@@ -3824,9 +3821,10 @@ export type CustomElementsSolidJs = {
|
|
|
3824
3821
|
|
|
3825
3822
|
/**
|
|
3826
3823
|
* Performs an action or renders a link with button styling.
|
|
3824
|
+
*
|
|
3827
3825
|
* Use button variants to match action priority, risk, and context.
|
|
3828
3826
|
*
|
|
3829
|
-
* [
|
|
3827
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/button/frameworks/elements)
|
|
3830
3828
|
*
|
|
3831
3829
|
* ## Attributes & Properties
|
|
3832
3830
|
*
|
|
@@ -3879,11 +3877,13 @@ export type CustomElementsSolidJs = {
|
|
|
3879
3877
|
>;
|
|
3880
3878
|
|
|
3881
3879
|
/**
|
|
3880
|
+
* Note: attention will soon be split into multiple components (tooltip, callout, popover, highlight) at which time this component will be deprecated. For now, use the `tooltip`, `callout`, `popover`, and `highlight` boolean properties to achieve the desired style and behavior.
|
|
3881
|
+
*
|
|
3882
3882
|
* Attention is a versatile component for displaying contextual information and messages. It can be used for a wide range of purposes, such as tooltips, callouts, popovers, and highlights.
|
|
3883
3883
|
*
|
|
3884
3884
|
* The component is designed to be anchored to a trigger element, providing contextual information related to that element. It supports various placements and styling options to accommodate different use cases and design needs.
|
|
3885
3885
|
*
|
|
3886
|
-
*
|
|
3886
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/tooltip/frameworks/elements)
|
|
3887
3887
|
*
|
|
3888
3888
|
* ## Attributes & Properties
|
|
3889
3889
|
*
|
|
@@ -3963,7 +3963,7 @@ export type CustomElementsSolidJs = {
|
|
|
3963
3963
|
/**
|
|
3964
3964
|
* Box is a layout component used for separating content areas on a page.
|
|
3965
3965
|
*
|
|
3966
|
-
* [
|
|
3966
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/box/frameworks/elements)
|
|
3967
3967
|
*
|
|
3968
3968
|
* ## Attributes & Properties
|
|
3969
3969
|
*
|
|
@@ -3986,9 +3986,10 @@ export type CustomElementsSolidJs = {
|
|
|
3986
3986
|
|
|
3987
3987
|
/**
|
|
3988
3988
|
* Shows the navigation structure for the current page.
|
|
3989
|
+
*
|
|
3989
3990
|
* Renders direct child links and non-link elements as a breadcrumb trail, inserts separators between items, and exposes the trail as navigation.
|
|
3990
3991
|
*
|
|
3991
|
-
* [
|
|
3992
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)
|
|
3992
3993
|
*
|
|
3993
3994
|
* ## Attributes & Properties
|
|
3994
3995
|
*
|
|
@@ -4008,7 +4009,7 @@ export type CustomElementsSolidJs = {
|
|
|
4008
4009
|
* Represents one item in a `w-breadcrumbs` trail.
|
|
4009
4010
|
* Renders the slotted label as a link when `href` is set, or as text when it is not, and adds a separator after non-current items.
|
|
4010
4011
|
*
|
|
4011
|
-
* [
|
|
4012
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)
|
|
4012
4013
|
*
|
|
4013
4014
|
* ## Attributes & Properties
|
|
4014
4015
|
*
|
|
@@ -4033,9 +4034,9 @@ export type CustomElementsSolidJs = {
|
|
|
4033
4034
|
>;
|
|
4034
4035
|
|
|
4035
4036
|
/**
|
|
4036
|
-
* Card is a layout component used for
|
|
4037
|
+
* Card is a layout component used for grouping interactive content areas on a page.
|
|
4037
4038
|
*
|
|
4038
|
-
* [
|
|
4039
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/card/frameworks/elements)
|
|
4039
4040
|
*
|
|
4040
4041
|
* ## Attributes & Properties
|
|
4041
4042
|
*
|
|
@@ -4050,7 +4051,6 @@ export type CustomElementsSolidJs = {
|
|
|
4050
4051
|
* - `clickable`: Whether the whole card is interactive.
|
|
4051
4052
|
*
|
|
4052
4053
|
* When set, the card becomes keyboard focusable and Enter or Space triggers a click on the card. Use this only when the whole card has one action or represents one selectable choice.
|
|
4053
|
-
* - `buttonText`: undefined (property only)
|
|
4054
4054
|
*
|
|
4055
4055
|
* ## Methods
|
|
4056
4056
|
*
|
|
@@ -4063,7 +4063,11 @@ export type CustomElementsSolidJs = {
|
|
|
4063
4063
|
>;
|
|
4064
4064
|
|
|
4065
4065
|
/**
|
|
4066
|
+
* Checkboxes allow users to select one or more options from a number of choices.
|
|
4067
|
+
*
|
|
4068
|
+
* Wrap individual checkboxes in a checkbox group.
|
|
4066
4069
|
*
|
|
4070
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/checkbox/frameworks/elements)
|
|
4067
4071
|
*
|
|
4068
4072
|
* ## Attributes & Properties
|
|
4069
4073
|
*
|
|
@@ -4095,12 +4099,6 @@ export type CustomElementsSolidJs = {
|
|
|
4095
4099
|
* - `validationMessage`: Returns the validation message if the checkbox is invalid, otherwise an empty string (property only) (readonly)
|
|
4096
4100
|
* - `validity`: Returns the validity state of the checkbox (property only) (readonly)
|
|
4097
4101
|
*
|
|
4098
|
-
* ## Events
|
|
4099
|
-
*
|
|
4100
|
-
* Events that will be emitted by the component.
|
|
4101
|
-
*
|
|
4102
|
-
* - `change`: undefined
|
|
4103
|
-
*
|
|
4104
4102
|
* ## Methods
|
|
4105
4103
|
*
|
|
4106
4104
|
* Methods that can be called to access component functionality.
|
|
@@ -4120,18 +4118,11 @@ export type CustomElementsSolidJs = {
|
|
|
4120
4118
|
>;
|
|
4121
4119
|
|
|
4122
4120
|
/**
|
|
4123
|
-
* Checkboxes allow users to select
|
|
4121
|
+
* Checkboxes allow users to select one or more options from a number of choices.
|
|
4124
4122
|
*
|
|
4125
|
-
*
|
|
4123
|
+
* Wrap individual checkboxes in a checkbox group.
|
|
4126
4124
|
*
|
|
4127
|
-
*
|
|
4128
|
-
* This component uses a <div> wrapper instead of the more semantic <fieldset> element.
|
|
4129
|
-
* Note that w-radio-group uses <fieldset>, which provides better accessibility and follows
|
|
4130
|
-
* HTML best practices. This inconsistency exists for historical reasons and may be addressed
|
|
4131
|
-
* in a future major version to align both on the more semantic approach.
|
|
4132
|
-
*
|
|
4133
|
-
* TODO: Align w-checkbox-group to use <fieldset> in a future major version after assessing
|
|
4134
|
-
* backwards compatibility implications (CSS selectors, etc.).
|
|
4125
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/checkbox/frameworks/elements)
|
|
4135
4126
|
*
|
|
4136
4127
|
* ## Attributes & Properties
|
|
4137
4128
|
*
|
|
@@ -4174,7 +4165,7 @@ export type CustomElementsSolidJs = {
|
|
|
4174
4165
|
/**
|
|
4175
4166
|
* A combobox element for text input with selectable options.
|
|
4176
4167
|
*
|
|
4177
|
-
* [
|
|
4168
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/combo-box/frameworks/elements)
|
|
4178
4169
|
*
|
|
4179
4170
|
* ## Attributes & Properties
|
|
4180
4171
|
*
|
|
@@ -4240,11 +4231,9 @@ export type CustomElementsSolidJs = {
|
|
|
4240
4231
|
>;
|
|
4241
4232
|
|
|
4242
4233
|
/**
|
|
4243
|
-
*
|
|
4244
|
-
*
|
|
4245
|
-
* Uses the `lang` attribute on either the element or on `<html>` to determine the locale options.
|
|
4234
|
+
* A date picker allows the user to select a specific calendar date.
|
|
4246
4235
|
*
|
|
4247
|
-
* [
|
|
4236
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/date-picker/frameworks/elements)
|
|
4248
4237
|
*
|
|
4249
4238
|
* ## Attributes & Properties
|
|
4250
4239
|
*
|
|
@@ -4307,6 +4296,8 @@ export type CustomElementsSolidJs = {
|
|
|
4307
4296
|
/**
|
|
4308
4297
|
* Expandable is a layout component used for creating expandable content areas on a page.
|
|
4309
4298
|
*
|
|
4299
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/expandable/frameworks/elements)
|
|
4300
|
+
*
|
|
4310
4301
|
* ## Attributes & Properties
|
|
4311
4302
|
*
|
|
4312
4303
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4339,6 +4330,8 @@ export type CustomElementsSolidJs = {
|
|
|
4339
4330
|
/**
|
|
4340
4331
|
* Modals (or dialogs) display important information that users need to acknowledge.
|
|
4341
4332
|
*
|
|
4333
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)
|
|
4334
|
+
*
|
|
4342
4335
|
* ## Attributes & Properties
|
|
4343
4336
|
*
|
|
4344
4337
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4400,6 +4393,8 @@ export type CustomElementsSolidJs = {
|
|
|
4400
4393
|
/**
|
|
4401
4394
|
* The footer section of a modal, typically where you place actions.
|
|
4402
4395
|
*
|
|
4396
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)
|
|
4397
|
+
*
|
|
4403
4398
|
* ## CSS Custom Properties
|
|
4404
4399
|
*
|
|
4405
4400
|
* CSS variables available for styling the component.
|
|
@@ -4422,6 +4417,8 @@ export type CustomElementsSolidJs = {
|
|
|
4422
4417
|
/**
|
|
4423
4418
|
* The header section of a modal, typically where you place the title and a close button.
|
|
4424
4419
|
*
|
|
4420
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)
|
|
4421
|
+
*
|
|
4425
4422
|
* ## Attributes & Properties
|
|
4426
4423
|
*
|
|
4427
4424
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4472,6 +4469,8 @@ export type CustomElementsSolidJs = {
|
|
|
4472
4469
|
*
|
|
4473
4470
|
* One dot is highlighted to indicate the currently selected page.
|
|
4474
4471
|
*
|
|
4472
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/page-indicator/frameworks/elements)
|
|
4473
|
+
*
|
|
4475
4474
|
* ## Attributes & Properties
|
|
4476
4475
|
*
|
|
4477
4476
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4489,6 +4488,8 @@ export type CustomElementsSolidJs = {
|
|
|
4489
4488
|
/**
|
|
4490
4489
|
* Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.
|
|
4491
4490
|
*
|
|
4491
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/pagination/frameworks/elements)
|
|
4492
|
+
*
|
|
4492
4493
|
* ## Attributes & Properties
|
|
4493
4494
|
*
|
|
4494
4495
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4516,6 +4517,8 @@ export type CustomElementsSolidJs = {
|
|
|
4516
4517
|
/**
|
|
4517
4518
|
* 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.
|
|
4518
4519
|
*
|
|
4520
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/pill/frameworks/elements)
|
|
4521
|
+
*
|
|
4519
4522
|
* ## Attributes & Properties
|
|
4520
4523
|
*
|
|
4521
4524
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4539,7 +4542,11 @@ export type CustomElementsSolidJs = {
|
|
|
4539
4542
|
>;
|
|
4540
4543
|
|
|
4541
4544
|
/**
|
|
4545
|
+
* Radios allow users to select a single option from a list of choices.
|
|
4546
|
+
*
|
|
4547
|
+
* Wrap individual radio components in a radio group.
|
|
4542
4548
|
*
|
|
4549
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/radio/frameworks/elements)
|
|
4543
4550
|
*
|
|
4544
4551
|
* ## Attributes & Properties
|
|
4545
4552
|
*
|
|
@@ -4559,7 +4566,9 @@ export type CustomElementsSolidJs = {
|
|
|
4559
4566
|
/**
|
|
4560
4567
|
* Radios allow users to select a single option from a list of choices.
|
|
4561
4568
|
*
|
|
4562
|
-
*
|
|
4569
|
+
* Wrap individual radio components in a radio group.
|
|
4570
|
+
*
|
|
4571
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/radio/frameworks/elements)
|
|
4563
4572
|
*
|
|
4564
4573
|
* ## Attributes & Properties
|
|
4565
4574
|
*
|
|
@@ -4580,7 +4589,7 @@ export type CustomElementsSolidJs = {
|
|
|
4580
4589
|
* Areas where markup can be added to the component.
|
|
4581
4590
|
*
|
|
4582
4591
|
* - `label`: Alternative to the `label` attribute should you need custom HTML.
|
|
4583
|
-
* - `help-text`: Alternative to the `help-text` attribute should you need custom HTML.
|
|
4592
|
+
* - `help-text`: Alternative to the `help-text` attribute should you need custom HTML.
|
|
4584
4593
|
*/
|
|
4585
4594
|
"w-radio-group": Partial<
|
|
4586
4595
|
WarpRadioGroupProps &
|
|
@@ -4592,6 +4601,8 @@ export type CustomElementsSolidJs = {
|
|
|
4592
4601
|
/**
|
|
4593
4602
|
* A dropdown component for selecting a single value.
|
|
4594
4603
|
*
|
|
4604
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/select/frameworks/elements)
|
|
4605
|
+
*
|
|
4595
4606
|
* ## Attributes & Properties
|
|
4596
4607
|
*
|
|
4597
4608
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4664,6 +4675,8 @@ export type CustomElementsSolidJs = {
|
|
|
4664
4675
|
/**
|
|
4665
4676
|
* Parent component for sliders (both single and range sliders). Used in combination with a `<w-slider-thumb>`.
|
|
4666
4677
|
*
|
|
4678
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/slider/frameworks/elements)
|
|
4679
|
+
*
|
|
4667
4680
|
* ## Attributes & Properties
|
|
4668
4681
|
*
|
|
4669
4682
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4713,6 +4726,8 @@ export type CustomElementsSolidJs = {
|
|
|
4713
4726
|
*
|
|
4714
4727
|
* See the `create` function on `w-snackbar` for a convenience API which helps you make snackbar items.
|
|
4715
4728
|
*
|
|
4729
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/snackbar/frameworks/elements)
|
|
4730
|
+
*
|
|
4716
4731
|
* ## Attributes & Properties
|
|
4717
4732
|
*
|
|
4718
4733
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4773,6 +4788,8 @@ export type CustomElementsSolidJs = {
|
|
|
4773
4788
|
*
|
|
4774
4789
|
* Include one `<w-snackbar></w-snackbar>` in the document `<body>`. Use the `create` function to create messages.
|
|
4775
4790
|
*
|
|
4791
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/snackbar/frameworks/elements)
|
|
4792
|
+
*
|
|
4776
4793
|
* ## Slots
|
|
4777
4794
|
*
|
|
4778
4795
|
* Areas where markup can be added to the component.
|
|
@@ -4821,7 +4838,9 @@ export type CustomElementsSolidJs = {
|
|
|
4821
4838
|
>;
|
|
4822
4839
|
|
|
4823
4840
|
/**
|
|
4824
|
-
* Individual step component that shows a single step in a process
|
|
4841
|
+
* Individual step component that shows a single step in a process.
|
|
4842
|
+
*
|
|
4843
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/steps/frameworks/elements)
|
|
4825
4844
|
*
|
|
4826
4845
|
* ## Attributes & Properties
|
|
4827
4846
|
*
|
|
@@ -4848,6 +4867,8 @@ export type CustomElementsSolidJs = {
|
|
|
4848
4867
|
/**
|
|
4849
4868
|
* Steps are used to show progress through a process or to guide users through a multi-step task.
|
|
4850
4869
|
*
|
|
4870
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/steps/frameworks/elements)
|
|
4871
|
+
*
|
|
4851
4872
|
* ## Attributes & Properties
|
|
4852
4873
|
*
|
|
4853
4874
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4865,6 +4886,8 @@ export type CustomElementsSolidJs = {
|
|
|
4865
4886
|
/**
|
|
4866
4887
|
* The Switch component allows users to toggle between two states.
|
|
4867
4888
|
*
|
|
4889
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/switch/frameworks/elements)
|
|
4890
|
+
*
|
|
4868
4891
|
* ## Attributes & Properties
|
|
4869
4892
|
*
|
|
4870
4893
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4898,6 +4921,8 @@ export type CustomElementsSolidJs = {
|
|
|
4898
4921
|
/**
|
|
4899
4922
|
* Individual tab component used within w-tabs container.
|
|
4900
4923
|
*
|
|
4924
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)
|
|
4925
|
+
*
|
|
4901
4926
|
* ## Attributes & Properties
|
|
4902
4927
|
*
|
|
4903
4928
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4911,8 +4936,11 @@ export type CustomElementsSolidJs = {
|
|
|
4911
4936
|
|
|
4912
4937
|
/**
|
|
4913
4938
|
* Tab panel component that holds content for individual tabs.
|
|
4939
|
+
*
|
|
4914
4940
|
* Each tab panel should have a name that matches a corresponding tab.
|
|
4915
4941
|
*
|
|
4942
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)
|
|
4943
|
+
*
|
|
4916
4944
|
* ## Attributes & Properties
|
|
4917
4945
|
*
|
|
4918
4946
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4929,6 +4957,8 @@ export type CustomElementsSolidJs = {
|
|
|
4929
4957
|
/**
|
|
4930
4958
|
* Tabs are used to organize content by grouping similar information on the same page.
|
|
4931
4959
|
*
|
|
4960
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)
|
|
4961
|
+
*
|
|
4932
4962
|
* ## Attributes & Properties
|
|
4933
4963
|
*
|
|
4934
4964
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
@@ -4939,7 +4969,7 @@ export type CustomElementsSolidJs = {
|
|
|
4939
4969
|
*
|
|
4940
4970
|
* Events that will be emitted by the component.
|
|
4941
4971
|
*
|
|
4942
|
-
* - `change`: Includes `details.panelId` with the now active tab's ID
|
|
4972
|
+
* - `change`: Includes `details.panelId` with the now active tab panel's ID
|
|
4943
4973
|
*/
|
|
4944
4974
|
"w-tabs": Partial<
|
|
4945
4975
|
WarpTabsProps & WarpTabsSolidJsProps & BaseProps<WarpTabs> & BaseEvents
|
|
@@ -4948,11 +4978,7 @@ export type CustomElementsSolidJs = {
|
|
|
4948
4978
|
/**
|
|
4949
4979
|
* A multi-line text input with built-in form validation, auto-resizing, and styling support.
|
|
4950
4980
|
*
|
|
4951
|
-
*
|
|
4952
|
-
* - Form integration
|
|
4953
|
-
* - Auto-resizing based on content and row constraints
|
|
4954
|
-
* - Built-in validation with customizable error messages
|
|
4955
|
-
* - Accessibility attributes and labeling
|
|
4981
|
+
* [Warp component reference](https://warp-ds.github.io/docs/components/text-area/frameworks/elements)
|
|
4956
4982
|
*
|
|
4957
4983
|
* ## Attributes & Properties
|
|
4958
4984
|
*
|