@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
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"declarations": [
|
|
9
9
|
{
|
|
10
10
|
"kind": "class",
|
|
11
|
-
"description": "A single-line input component used for entering and editing textual or numeric data.",
|
|
11
|
+
"description": "A single-line input component used for entering and editing textual or numeric data.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/text-area/frameworks/elements)",
|
|
12
12
|
"name": "WarpTextField",
|
|
13
13
|
"slots": [
|
|
14
14
|
{
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"name": "suffix"
|
|
17
17
|
},
|
|
18
18
|
{
|
|
19
|
-
"description": "Use with `<w-affix>` to include a prefix, for example a search icon.
|
|
19
|
+
"description": "Use with `<w-affix>` to include a prefix, for example a search icon.",
|
|
20
20
|
"name": "prefix"
|
|
21
21
|
}
|
|
22
22
|
],
|
|
@@ -555,7 +555,7 @@
|
|
|
555
555
|
"declarations": [
|
|
556
556
|
{
|
|
557
557
|
"kind": "class",
|
|
558
|
-
"description": "",
|
|
558
|
+
"description": "[Warp component reference](https://warp-ds.github.io/docs/components/icons/frameworks/elements)",
|
|
559
559
|
"name": "WarpIcon",
|
|
560
560
|
"members": [
|
|
561
561
|
{
|
|
@@ -712,7 +712,7 @@
|
|
|
712
712
|
"declarations": [
|
|
713
713
|
{
|
|
714
714
|
"kind": "class",
|
|
715
|
-
"description": "This component is usually used in other components like form elements to show a prefix or suffix. See for example `w-textfield`.\n\n
|
|
715
|
+
"description": "This component is usually used in other components like form elements to show a prefix or suffix. See for example `w-textfield`.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/text-field/frameworks/elements#prefix-label)",
|
|
716
716
|
"name": "WarpAffix",
|
|
717
717
|
"members": [
|
|
718
718
|
{
|
|
@@ -866,7 +866,7 @@
|
|
|
866
866
|
"declarations": [
|
|
867
867
|
{
|
|
868
868
|
"kind": "class",
|
|
869
|
-
"description": "Alert is an inline component used for displaying different types of messages.\n\
|
|
869
|
+
"description": "Alert is an inline component used for displaying different types of messages.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/alert/frameworks/elements)",
|
|
870
870
|
"name": "WarpAlert",
|
|
871
871
|
"members": [
|
|
872
872
|
{
|
|
@@ -981,7 +981,7 @@
|
|
|
981
981
|
"declarations": [
|
|
982
982
|
{
|
|
983
983
|
"kind": "class",
|
|
984
|
-
"description": "
|
|
984
|
+
"description": "Link component to use when creating links that look like buttons.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/link/frameworks/elements)",
|
|
985
985
|
"name": "WarpLink",
|
|
986
986
|
"members": [
|
|
987
987
|
{
|
|
@@ -1180,7 +1180,7 @@
|
|
|
1180
1180
|
"declarations": [
|
|
1181
1181
|
{
|
|
1182
1182
|
"kind": "class",
|
|
1183
|
-
"description": "Performs an action or renders a link with button styling.\nUse button variants to match action priority, risk, and context.\n\n[
|
|
1183
|
+
"description": "Performs an action or renders a link with button styling.\n\nUse button variants to match action priority, risk, and context.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/button/frameworks/elements)",
|
|
1184
1184
|
"name": "WarpButton",
|
|
1185
1185
|
"members": [
|
|
1186
1186
|
{
|
|
@@ -1627,7 +1627,7 @@
|
|
|
1627
1627
|
"declarations": [
|
|
1628
1628
|
{
|
|
1629
1629
|
"kind": "class",
|
|
1630
|
-
"description": "
|
|
1630
|
+
"description": "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.\n\nAttention 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.\n\nThe 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.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tooltip/frameworks/elements)",
|
|
1631
1631
|
"name": "WarpAttention",
|
|
1632
1632
|
"members": [
|
|
1633
1633
|
{
|
|
@@ -2084,7 +2084,7 @@
|
|
|
2084
2084
|
"declarations": [
|
|
2085
2085
|
{
|
|
2086
2086
|
"kind": "class",
|
|
2087
|
-
"description": "Box is a layout component used for separating content areas on a page.\n\n[
|
|
2087
|
+
"description": "Box is a layout component used for separating content areas on a page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/box/frameworks/elements)",
|
|
2088
2088
|
"name": "WarpBox",
|
|
2089
2089
|
"members": [
|
|
2090
2090
|
{
|
|
@@ -2231,7 +2231,7 @@
|
|
|
2231
2231
|
"declarations": [
|
|
2232
2232
|
{
|
|
2233
2233
|
"kind": "class",
|
|
2234
|
-
"description": "Shows the navigation structure for the current page.\nRenders direct child links and non-link elements as a breadcrumb trail, inserts separators between items, and exposes the trail as navigation.\n\n[
|
|
2234
|
+
"description": "Shows the navigation structure for the current page.\n\nRenders direct child links and non-link elements as a breadcrumb trail, inserts separators between items, and exposes the trail as navigation.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)",
|
|
2235
2235
|
"name": "WarpBreadcrumbs",
|
|
2236
2236
|
"members": [
|
|
2237
2237
|
{
|
|
@@ -2312,7 +2312,7 @@
|
|
|
2312
2312
|
"declarations": [
|
|
2313
2313
|
{
|
|
2314
2314
|
"kind": "class",
|
|
2315
|
-
"description": "Represents one item in a `w-breadcrumbs` trail.\nRenders 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.\n\n[
|
|
2315
|
+
"description": "Represents one item in a `w-breadcrumbs` trail.\nRenders 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.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)",
|
|
2316
2316
|
"name": "WarpBreadcrumbItem",
|
|
2317
2317
|
"slots": [
|
|
2318
2318
|
{
|
|
@@ -2401,7 +2401,7 @@
|
|
|
2401
2401
|
"declarations": [
|
|
2402
2402
|
{
|
|
2403
2403
|
"kind": "class",
|
|
2404
|
-
"description": "Card is a layout component used for
|
|
2404
|
+
"description": "Card is a layout component used for grouping interactive content areas on a page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/card/frameworks/elements)",
|
|
2405
2405
|
"name": "WarpCard",
|
|
2406
2406
|
"members": [
|
|
2407
2407
|
{
|
|
@@ -2435,6 +2435,14 @@
|
|
|
2435
2435
|
"description": "Whether the whole card is interactive.\n\nWhen 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.",
|
|
2436
2436
|
"attribute": "clickable"
|
|
2437
2437
|
},
|
|
2438
|
+
{
|
|
2439
|
+
"kind": "field",
|
|
2440
|
+
"name": "buttonText",
|
|
2441
|
+
"type": {
|
|
2442
|
+
"text": "string"
|
|
2443
|
+
},
|
|
2444
|
+
"privacy": "private"
|
|
2445
|
+
},
|
|
2438
2446
|
{
|
|
2439
2447
|
"kind": "method",
|
|
2440
2448
|
"name": "keypressed",
|
|
@@ -2449,10 +2457,6 @@
|
|
|
2449
2457
|
"type": {
|
|
2450
2458
|
"text": "keypressed(e: KeyboardEvent) => void"
|
|
2451
2459
|
}
|
|
2452
|
-
},
|
|
2453
|
-
{
|
|
2454
|
-
"kind": "field",
|
|
2455
|
-
"name": "buttonText"
|
|
2456
2460
|
}
|
|
2457
2461
|
],
|
|
2458
2462
|
"attributes": [
|
|
@@ -2519,7 +2523,7 @@
|
|
|
2519
2523
|
"declarations": [
|
|
2520
2524
|
{
|
|
2521
2525
|
"kind": "class",
|
|
2522
|
-
"description": "",
|
|
2526
|
+
"description": "Checkboxes allow users to select one or more options from a number of choices.\n\nWrap individual checkboxes in a checkbox group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/checkbox/frameworks/elements)",
|
|
2523
2527
|
"name": "WarpCheckbox",
|
|
2524
2528
|
"members": [
|
|
2525
2529
|
{
|
|
@@ -2779,14 +2783,6 @@
|
|
|
2779
2783
|
}
|
|
2780
2784
|
}
|
|
2781
2785
|
],
|
|
2782
|
-
"events": [
|
|
2783
|
-
{
|
|
2784
|
-
"name": "change",
|
|
2785
|
-
"type": {
|
|
2786
|
-
"text": "Event"
|
|
2787
|
-
}
|
|
2788
|
-
}
|
|
2789
|
-
],
|
|
2790
2786
|
"attributes": [
|
|
2791
2787
|
{
|
|
2792
2788
|
"name": "name",
|
|
@@ -2910,7 +2906,7 @@
|
|
|
2910
2906
|
"declarations": [
|
|
2911
2907
|
{
|
|
2912
2908
|
"kind": "class",
|
|
2913
|
-
"description": "Checkboxes allow users to select
|
|
2909
|
+
"description": "Checkboxes allow users to select one or more options from a number of choices.\n\nWrap individual checkboxes in a checkbox group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/checkbox/frameworks/elements)",
|
|
2914
2910
|
"name": "WarpCheckboxGroup",
|
|
2915
2911
|
"members": [
|
|
2916
2912
|
{
|
|
@@ -3344,7 +3340,7 @@
|
|
|
3344
3340
|
"declarations": [
|
|
3345
3341
|
{
|
|
3346
3342
|
"kind": "class",
|
|
3347
|
-
"description": "A combobox element for text input with selectable options.\n\n[
|
|
3343
|
+
"description": "A combobox element for text input with selectable options.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/combo-box/frameworks/elements)",
|
|
3348
3344
|
"name": "WarpCombobox",
|
|
3349
3345
|
"members": [
|
|
3350
3346
|
{
|
|
@@ -3962,7 +3958,7 @@
|
|
|
3962
3958
|
"declarations": [
|
|
3963
3959
|
{
|
|
3964
3960
|
"kind": "class",
|
|
3965
|
-
"description": "
|
|
3961
|
+
"description": "A date picker allows the user to select a specific calendar date.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/date-picker/frameworks/elements)",
|
|
3966
3962
|
"name": "WarpDatepicker",
|
|
3967
3963
|
"members": [
|
|
3968
3964
|
{
|
|
@@ -4364,7 +4360,7 @@
|
|
|
4364
4360
|
"declarations": [
|
|
4365
4361
|
{
|
|
4366
4362
|
"kind": "class",
|
|
4367
|
-
"description": "Expandable is a layout component used for creating expandable content areas on a page.",
|
|
4363
|
+
"description": "Expandable is a layout component used for creating expandable content areas on a page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/expandable/frameworks/elements)",
|
|
4368
4364
|
"name": "WarpExpandable",
|
|
4369
4365
|
"slots": [
|
|
4370
4366
|
{
|
|
@@ -4647,7 +4643,7 @@
|
|
|
4647
4643
|
"declarations": [
|
|
4648
4644
|
{
|
|
4649
4645
|
"kind": "class",
|
|
4650
|
-
"description": "Modals (or dialogs) display important information that users need to acknowledge.",
|
|
4646
|
+
"description": "Modals (or dialogs) display important information that users need to acknowledge.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)",
|
|
4651
4647
|
"name": "WarpModal",
|
|
4652
4648
|
"cssProperties": [
|
|
4653
4649
|
{
|
|
@@ -4936,7 +4932,7 @@
|
|
|
4936
4932
|
"declarations": [
|
|
4937
4933
|
{
|
|
4938
4934
|
"kind": "class",
|
|
4939
|
-
"description": "The footer section of a modal, typically where you place actions.",
|
|
4935
|
+
"description": "The footer section of a modal, typically where you place actions.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)",
|
|
4940
4936
|
"name": "WarpModalFooter",
|
|
4941
4937
|
"cssProperties": [
|
|
4942
4938
|
{
|
|
@@ -5014,7 +5010,7 @@
|
|
|
5014
5010
|
"declarations": [
|
|
5015
5011
|
{
|
|
5016
5012
|
"kind": "class",
|
|
5017
|
-
"description": "The header section of a modal, typically where you place the title and a close button.",
|
|
5013
|
+
"description": "The header section of a modal, typically where you place the title and a close button.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)",
|
|
5018
5014
|
"name": "WarpModalHeader",
|
|
5019
5015
|
"cssProperties": [
|
|
5020
5016
|
{
|
|
@@ -5216,7 +5212,7 @@
|
|
|
5216
5212
|
"declarations": [
|
|
5217
5213
|
{
|
|
5218
5214
|
"kind": "class",
|
|
5219
|
-
"description": "A page indicator component that displays a series of dots representing pages.\n\nOne dot is highlighted to indicate the currently selected page.",
|
|
5215
|
+
"description": "A page indicator component that displays a series of dots representing pages.\n\nOne dot is highlighted to indicate the currently selected page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/page-indicator/frameworks/elements)",
|
|
5220
5216
|
"name": "WarpPageIndicator",
|
|
5221
5217
|
"members": [
|
|
5222
5218
|
{
|
|
@@ -5317,7 +5313,7 @@
|
|
|
5317
5313
|
"declarations": [
|
|
5318
5314
|
{
|
|
5319
5315
|
"kind": "class",
|
|
5320
|
-
"description": "Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.",
|
|
5316
|
+
"description": "Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/pagination/frameworks/elements)",
|
|
5321
5317
|
"name": "WarpPagination",
|
|
5322
5318
|
"members": [
|
|
5323
5319
|
{
|
|
@@ -5458,7 +5454,7 @@
|
|
|
5458
5454
|
"declarations": [
|
|
5459
5455
|
{
|
|
5460
5456
|
"kind": "class",
|
|
5461
|
-
"description": "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.",
|
|
5457
|
+
"description": "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.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/pill/frameworks/elements)",
|
|
5462
5458
|
"name": "WarpPill",
|
|
5463
5459
|
"members": [
|
|
5464
5460
|
{
|
|
@@ -5659,7 +5655,7 @@
|
|
|
5659
5655
|
"declarations": [
|
|
5660
5656
|
{
|
|
5661
5657
|
"kind": "class",
|
|
5662
|
-
"description": "",
|
|
5658
|
+
"description": "Radios allow users to select a single option from a list of choices.\n\nWrap individual radio components in a radio group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/radio/frameworks/elements)",
|
|
5663
5659
|
"name": "WarpRadio",
|
|
5664
5660
|
"members": [
|
|
5665
5661
|
{
|
|
@@ -5993,7 +5989,7 @@
|
|
|
5993
5989
|
"declarations": [
|
|
5994
5990
|
{
|
|
5995
5991
|
"kind": "class",
|
|
5996
|
-
"description": "Radios allow users to select a single option from a list of choices.\n\
|
|
5992
|
+
"description": "Radios allow users to select a single option from a list of choices.\n\nWrap individual radio components in a radio group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/radio/frameworks/elements)",
|
|
5997
5993
|
"name": "WarpRadioGroup",
|
|
5998
5994
|
"slots": [
|
|
5999
5995
|
{
|
|
@@ -6001,7 +5997,7 @@
|
|
|
6001
5997
|
"name": "label"
|
|
6002
5998
|
},
|
|
6003
5999
|
{
|
|
6004
|
-
"description": "Alternative to the `help-text` attribute should you need custom HTML.
|
|
6000
|
+
"description": "Alternative to the `help-text` attribute should you need custom HTML.",
|
|
6005
6001
|
"name": "help-text"
|
|
6006
6002
|
}
|
|
6007
6003
|
],
|
|
@@ -6482,7 +6478,7 @@
|
|
|
6482
6478
|
"declarations": [
|
|
6483
6479
|
{
|
|
6484
6480
|
"kind": "class",
|
|
6485
|
-
"description": "A dropdown component for selecting a single value.",
|
|
6481
|
+
"description": "A dropdown component for selecting a single value.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/select/frameworks/elements)",
|
|
6486
6482
|
"name": "WarpSelect",
|
|
6487
6483
|
"members": [
|
|
6488
6484
|
{
|
|
@@ -6743,6 +6739,19 @@
|
|
|
6743
6739
|
"name": "#helpId",
|
|
6744
6740
|
"privacy": "private",
|
|
6745
6741
|
"readonly": true
|
|
6742
|
+
},
|
|
6743
|
+
{
|
|
6744
|
+
"kind": "method",
|
|
6745
|
+
"name": "onChange",
|
|
6746
|
+
"privacy": "private",
|
|
6747
|
+
"parameters": [
|
|
6748
|
+
{
|
|
6749
|
+
"name": "event",
|
|
6750
|
+
"type": {
|
|
6751
|
+
"text": "Event"
|
|
6752
|
+
}
|
|
6753
|
+
}
|
|
6754
|
+
]
|
|
6746
6755
|
}
|
|
6747
6756
|
],
|
|
6748
6757
|
"events": [
|
|
@@ -7220,7 +7229,7 @@
|
|
|
7220
7229
|
"declarations": [
|
|
7221
7230
|
{
|
|
7222
7231
|
"kind": "class",
|
|
7223
|
-
"description": "Parent component for sliders (both single and range sliders). Used in combination with a `<w-slider-thumb
|
|
7232
|
+
"description": "Parent component for sliders (both single and range sliders). Used in combination with a `<w-slider-thumb>`.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/slider/frameworks/elements)",
|
|
7224
7233
|
"name": "WarpSlider",
|
|
7225
7234
|
"slots": [
|
|
7226
7235
|
{
|
|
@@ -7700,7 +7709,7 @@
|
|
|
7700
7709
|
"declarations": [
|
|
7701
7710
|
{
|
|
7702
7711
|
"kind": "class",
|
|
7703
|
-
"description": "An item to show in a `w-snackbar`.\n\nSee the `create` function on `w-snackbar` for a convenience API which helps you make snackbar items.",
|
|
7712
|
+
"description": "An item to show in a `w-snackbar`.\n\nSee the `create` function on `w-snackbar` for a convenience API which helps you make snackbar items.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/snackbar/frameworks/elements)",
|
|
7704
7713
|
"name": "WarpSnackbarItem",
|
|
7705
7714
|
"cssProperties": [
|
|
7706
7715
|
{
|
|
@@ -7973,7 +7982,7 @@
|
|
|
7973
7982
|
"declarations": [
|
|
7974
7983
|
{
|
|
7975
7984
|
"kind": "class",
|
|
7976
|
-
"description": "A Snackbar shows brief user feedback messages that overlay content, with an optional action such as Undo.\n\nInclude one `<w-snackbar></w-snackbar>` in the document `<body>`. Use the `create` function to create messages.",
|
|
7985
|
+
"description": "A Snackbar shows brief user feedback messages that overlay content, with an optional action such as Undo.\n\nInclude one `<w-snackbar></w-snackbar>` in the document `<body>`. Use the `create` function to create messages.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/snackbar/frameworks/elements)",
|
|
7977
7986
|
"name": "WarpSnackbar",
|
|
7978
7987
|
"cssProperties": [
|
|
7979
7988
|
{
|
|
@@ -8072,7 +8081,7 @@
|
|
|
8072
8081
|
"declarations": [
|
|
8073
8082
|
{
|
|
8074
8083
|
"kind": "class",
|
|
8075
|
-
"description": "Individual step component that shows a single step in a process",
|
|
8084
|
+
"description": "Individual step component that shows a single step in a process.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/steps/frameworks/elements)",
|
|
8076
8085
|
"name": "WarpStep",
|
|
8077
8086
|
"members": [
|
|
8078
8087
|
{
|
|
@@ -8196,7 +8205,7 @@
|
|
|
8196
8205
|
"declarations": [
|
|
8197
8206
|
{
|
|
8198
8207
|
"kind": "class",
|
|
8199
|
-
"description": "Steps are used to show progress through a process or to guide users through a multi-step task.",
|
|
8208
|
+
"description": "Steps are used to show progress through a process or to guide users through a multi-step task.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/steps/frameworks/elements)",
|
|
8200
8209
|
"name": "WarpStepIndicator",
|
|
8201
8210
|
"members": [
|
|
8202
8211
|
{
|
|
@@ -8277,7 +8286,7 @@
|
|
|
8277
8286
|
"declarations": [
|
|
8278
8287
|
{
|
|
8279
8288
|
"kind": "class",
|
|
8280
|
-
"description": "The Switch component allows users to toggle between two states.",
|
|
8289
|
+
"description": "The Switch component allows users to toggle between two states.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/switch/frameworks/elements)",
|
|
8281
8290
|
"name": "WarpSwitch",
|
|
8282
8291
|
"members": [
|
|
8283
8292
|
{
|
|
@@ -8430,7 +8439,7 @@
|
|
|
8430
8439
|
"declarations": [
|
|
8431
8440
|
{
|
|
8432
8441
|
"kind": "class",
|
|
8433
|
-
"description": "Individual tab component used within w-tabs container.",
|
|
8442
|
+
"description": "Individual tab component used within w-tabs container.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)",
|
|
8434
8443
|
"name": "WarpTab",
|
|
8435
8444
|
"members": [
|
|
8436
8445
|
{
|
|
@@ -8560,7 +8569,7 @@
|
|
|
8560
8569
|
"declarations": [
|
|
8561
8570
|
{
|
|
8562
8571
|
"kind": "class",
|
|
8563
|
-
"description": "Tab panel component that holds content for individual tabs.\nEach tab panel should have a name that matches a corresponding tab.",
|
|
8572
|
+
"description": "Tab panel component that holds content for individual tabs.\n\nEach tab panel should have a name that matches a corresponding tab.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)",
|
|
8564
8573
|
"name": "WarpTabPanel",
|
|
8565
8574
|
"members": [
|
|
8566
8575
|
{
|
|
@@ -8644,7 +8653,7 @@
|
|
|
8644
8653
|
"declarations": [
|
|
8645
8654
|
{
|
|
8646
8655
|
"kind": "class",
|
|
8647
|
-
"description": "Tabs are used to organize content by grouping similar information on the same page.",
|
|
8656
|
+
"description": "Tabs are used to organize content by grouping similar information on the same page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)",
|
|
8648
8657
|
"name": "WarpTabs",
|
|
8649
8658
|
"members": [
|
|
8650
8659
|
{
|
|
@@ -8755,7 +8764,7 @@
|
|
|
8755
8764
|
"type": {
|
|
8756
8765
|
"text": "WarpTabsChangeEvent"
|
|
8757
8766
|
},
|
|
8758
|
-
"description": "Includes `details.panelId` with the now active tab's ID"
|
|
8767
|
+
"description": "Includes `details.panelId` with the now active tab panel's ID"
|
|
8759
8768
|
}
|
|
8760
8769
|
],
|
|
8761
8770
|
"attributes": [
|
|
@@ -8804,7 +8813,7 @@
|
|
|
8804
8813
|
"declarations": [
|
|
8805
8814
|
{
|
|
8806
8815
|
"kind": "class",
|
|
8807
|
-
"description": "A multi-line text input with built-in form validation, auto-resizing, and styling support.\n\
|
|
8816
|
+
"description": "A multi-line text input with built-in form validation, auto-resizing, and styling support.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/text-area/frameworks/elements)",
|
|
8808
8817
|
"name": "WarpTextarea",
|
|
8809
8818
|
"members": [
|
|
8810
8819
|
{
|
package/dist/docs/affix/affix.md
CHANGED
|
@@ -4,15 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
This component is usually used in other components like form elements to show a prefix or suffix. See for example `w-textfield`.
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
Due to shadow DOM encapsulation, ARIA attributes (like `aria-describedby`, `aria-labelledby`)
|
|
9
|
-
cannot reference elements across shadow boundaries. This means:
|
|
10
|
-
- Non-interactive affixes (text labels, icons) cannot be connected to the parent input via ARIA
|
|
11
|
-
- Interactive affixes (buttons) must have their own `aria-label` (already implemented)
|
|
12
|
-
- Do NOT attempt to reference affix content from parent components via ARIA ID references - it won't work
|
|
13
|
-
|
|
14
|
-
For non-interactive labels (e.g., currency symbols), consider including the information in the
|
|
15
|
-
main label or placeholder instead of relying on ARIA to announce affix content.
|
|
7
|
+
[Warp component reference](https://warp-ds.github.io/docs/components/text-field/frameworks/elements#prefix-label)
|
|
16
8
|
|
|
17
9
|
## Usage
|
|
18
10
|
|
package/dist/docs/alert/alert.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Alert is an inline component used for displaying different types of messages.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
[Warp component reference](https://warp-ds.github.io/docs/components/alert/frameworks/elements)
|
|
8
8
|
|
|
9
9
|
## Usage
|
|
10
10
|
|
|
@@ -2,11 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
## Description
|
|
4
4
|
|
|
5
|
+
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.
|
|
6
|
+
|
|
5
7
|
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.
|
|
6
8
|
|
|
7
9
|
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.
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
[Warp component reference](https://warp-ds.github.io/docs/components/tooltip/frameworks/elements)
|
|
10
12
|
|
|
11
13
|
## Usage
|
|
12
14
|
|
package/dist/docs/box/box.md
CHANGED
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Box is a layout component used for separating content areas on a page.
|
|
6
6
|
|
|
7
|
+
[Warp component reference](https://warp-ds.github.io/docs/components/box/frameworks/elements)
|
|
8
|
+
|
|
7
9
|
## Usage
|
|
8
10
|
|
|
9
11
|
Box is a layout component for visually separating a section of content from the surrounding page.
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
Represents one item in a `w-breadcrumbs` trail.
|
|
6
6
|
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.
|
|
7
7
|
|
|
8
|
+
[Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)
|
|
9
|
+
|
|
8
10
|
### `<w-breadcrumb-item>` API
|
|
9
11
|
|
|
10
12
|
#### Properties
|
|
@@ -3,8 +3,11 @@
|
|
|
3
3
|
## Description
|
|
4
4
|
|
|
5
5
|
Shows the navigation structure for the current page.
|
|
6
|
+
|
|
6
7
|
Renders direct child links and non-link elements as a breadcrumb trail, inserts separators between items, and exposes the trail as navigation.
|
|
7
8
|
|
|
9
|
+
[Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)
|
|
10
|
+
|
|
8
11
|
## Usage
|
|
9
12
|
|
|
10
13
|
Breadcrumbs show where the current page sits in a site hierarchy and let users move back to parent pages.
|
|
@@ -3,8 +3,11 @@
|
|
|
3
3
|
## Description
|
|
4
4
|
|
|
5
5
|
Performs an action or renders a link with button styling.
|
|
6
|
+
|
|
6
7
|
Use button variants to match action priority, risk, and context.
|
|
7
8
|
|
|
9
|
+
[Warp component reference](https://warp-ds.github.io/docs/components/button/frameworks/elements)
|
|
10
|
+
|
|
8
11
|
## Usage
|
|
9
12
|
|
|
10
13
|
Button is used for actions. Use it when the user can submit, save, confirm, cancel, open, close, or trigger something on the current page.
|
package/dist/docs/card/api.md
CHANGED
|
@@ -6,7 +6,6 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
|
|
|
6
6
|
|
|
7
7
|
| Name | Type | Default | Summary |
|
|
8
8
|
|-|-|-|-|
|
|
9
|
-
| buttonText (JS only) | `unknown` | `-` | - |
|
|
10
9
|
| clickable | `boolean` | `false` | Whether the whole card is interactive. |
|
|
11
10
|
| flat | `boolean` | `false` | Whether the card uses the flat visual treatment. |
|
|
12
11
|
| keypressed (JS only) | `keypressed(e: KeyboardEvent) => void` | `-` | - |
|
|
@@ -14,13 +13,6 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
|
|
|
14
13
|
|
|
15
14
|
### Property Details
|
|
16
15
|
|
|
17
|
-
#### buttonText (JS only)
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
- Type: `unknown`
|
|
22
|
-
- Default: `-`
|
|
23
|
-
|
|
24
16
|
#### clickable
|
|
25
17
|
|
|
26
18
|
Whether the whole card is interactive.
|
package/dist/docs/card/card.md
CHANGED
|
@@ -2,13 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
## Description
|
|
4
4
|
|
|
5
|
-
Card is a layout component used for
|
|
5
|
+
Card is a layout component used for grouping interactive content areas on a page.
|
|
6
|
+
|
|
7
|
+
[Warp component reference](https://warp-ds.github.io/docs/components/card/frameworks/elements)
|
|
6
8
|
|
|
7
9
|
## Usage
|
|
8
10
|
|
|
9
|
-
Card is a layout component for
|
|
11
|
+
Card is a layout component used for grouping interactive content areas on a page.
|
|
12
|
+
|
|
13
|
+
Use `w-card` for listings, summaries, recommendations, or selectable choices where the grouped content should feel like a single object.
|
|
10
14
|
|
|
11
|
-
|
|
15
|
+
The component does not add padding, headings, spacing between children, or semantic structure. Those must be provided by the content inside the card.
|
|
12
16
|
|
|
13
17
|
### Basic Card
|
|
14
18
|
|
|
@@ -237,6 +241,57 @@ Use a button for an action on the current page:
|
|
|
237
241
|
|
|
238
242
|
## Styling API
|
|
239
243
|
|
|
244
|
+
Card supports styling through **component tokens** (CSS custom properties with a `--w-c-` prefix) and **parts**.
|
|
245
|
+
|
|
246
|
+
### Parts
|
|
247
|
+
|
|
248
|
+
Use `::part(part-name)` from outside the component.
|
|
249
|
+
|
|
250
|
+
- `base` - the root element of the card
|
|
251
|
+
- `border` - the inset border of the card
|
|
252
|
+
|
|
253
|
+
```css
|
|
254
|
+
w-card::part(base) {
|
|
255
|
+
padding: 48px;
|
|
256
|
+
background: rebeccapurple;
|
|
257
|
+
color: cyan;
|
|
258
|
+
}
|
|
259
|
+
w-card::part(border) {
|
|
260
|
+
border-color: magenta;
|
|
261
|
+
border-width: 8px;
|
|
262
|
+
}
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### Component tokens
|
|
266
|
+
|
|
267
|
+
Set these on `<w-card>` to override visuals.
|
|
268
|
+
|
|
269
|
+
```css
|
|
270
|
+
w-card {
|
|
271
|
+
--w-c-card-border-radius: 0px;
|
|
272
|
+
}
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
##### Layout and typography
|
|
276
|
+
|
|
277
|
+
- `--w-c-card-border-radius`
|
|
278
|
+
- `--w-c-card-border-width`
|
|
279
|
+
- `--w-c-card-border-color`
|
|
280
|
+
- `--w-c-card-border-color-active`
|
|
281
|
+
- `--w-c-card-border-color-hover`
|
|
282
|
+
|
|
283
|
+
##### Background
|
|
284
|
+
|
|
285
|
+
- `--w-c-card-bg`
|
|
286
|
+
- `--w-c-card-bg-active`
|
|
287
|
+
- `--w-c-card-bg-hover`
|
|
288
|
+
|
|
289
|
+
##### Shadow
|
|
290
|
+
|
|
291
|
+
- `--w-c-card-box-shadow`
|
|
292
|
+
- `--w-c-card-box-shadow-active`
|
|
293
|
+
- `--w-c-card-box-shadow-hover`
|
|
294
|
+
|
|
240
295
|
## `<w-card>` API
|
|
241
296
|
|
|
242
297
|
Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
|
|
@@ -245,7 +300,6 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
|
|
|
245
300
|
|
|
246
301
|
| Name | Type | Default | Summary |
|
|
247
302
|
|-|-|-|-|
|
|
248
|
-
| buttonText (JS only) | `unknown` | `-` | - |
|
|
249
303
|
| clickable | `boolean` | `false` | Whether the whole card is interactive. |
|
|
250
304
|
| flat | `boolean` | `false` | Whether the card uses the flat visual treatment. |
|
|
251
305
|
| keypressed (JS only) | `keypressed(e: KeyboardEvent) => void` | `-` | - |
|
|
@@ -253,13 +307,6 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
|
|
|
253
307
|
|
|
254
308
|
### Property Details
|
|
255
309
|
|
|
256
|
-
#### buttonText (JS only)
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
- Type: `unknown`
|
|
261
|
-
- Default: `-`
|
|
262
|
-
|
|
263
310
|
#### clickable
|
|
264
311
|
|
|
265
312
|
Whether the whole card is interactive.
|