@shopify/ui-extensions 2026.4.0 → 2026.4.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/build/ts/surfaces/admin/api/generated/generated.d.ts +62 -0
- package/build/ts/surfaces/admin/api/generated/generated.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api.d.ts +1 -0
- package/build/ts/surfaces/admin/api.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts +1 -1
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts +2 -2
- package/build/ts/surfaces/checkout/components/Abbreviation.d.ts +1 -4
- package/build/ts/surfaces/checkout/components/Announcement.d.ts +2 -6
- package/build/ts/surfaces/checkout/components/Badge.d.ts +1 -3
- package/build/ts/surfaces/checkout/components/Banner.d.ts +2 -6
- package/build/ts/surfaces/checkout/components/Box.d.ts +1 -3
- package/build/ts/surfaces/checkout/components/Button.d.ts +2 -8
- package/build/ts/surfaces/checkout/components/Checkbox.d.ts +2 -9
- package/build/ts/surfaces/checkout/components/Chip.d.ts +3 -11
- package/build/ts/surfaces/checkout/components/Choice.d.ts +2 -8
- package/build/ts/surfaces/checkout/components/ChoiceList.d.ts +2 -9
- package/build/ts/surfaces/checkout/components/Clickable.d.ts +2 -8
- package/build/ts/surfaces/checkout/components/ClickableChip.d.ts +4 -15
- package/build/ts/surfaces/checkout/components/ClipboardItem.d.ts +2 -8
- package/build/ts/surfaces/checkout/components/ConsentCheckbox.d.ts +8 -9
- package/build/ts/surfaces/checkout/components/ConsentPhoneField.d.ts +9 -14
- package/build/ts/surfaces/checkout/components/DateField.d.ts +2 -9
- package/build/ts/surfaces/checkout/components/DatePicker.d.ts +2 -9
- package/build/ts/surfaces/checkout/components/Details.d.ts +7 -16
- package/build/ts/surfaces/checkout/components/DropZone.d.ts +2 -9
- package/build/ts/surfaces/checkout/components/EmailField.d.ts +3 -14
- package/build/ts/surfaces/checkout/components/Form.d.ts +2 -9
- package/build/ts/surfaces/checkout/components/Grid.d.ts +1 -3
- package/build/ts/surfaces/checkout/components/GridItem.d.ts +1 -3
- package/build/ts/surfaces/checkout/components/Heading.d.ts +1 -4
- package/build/ts/surfaces/checkout/components/Link.d.ts +2 -8
- package/build/ts/surfaces/checkout/components/ListItem.d.ts +1 -4
- package/build/ts/surfaces/checkout/components/MapMarker.d.ts +3 -6
- package/build/ts/surfaces/checkout/components/MoneyField.d.ts +2 -9
- package/build/ts/surfaces/checkout/components/NumberField.d.ts +3 -14
- package/build/ts/surfaces/checkout/components/Option.d.ts +1 -4
- package/build/ts/surfaces/checkout/components/OrderedList.d.ts +1 -4
- package/build/ts/surfaces/checkout/components/Paragraph.d.ts +12 -4
- package/build/ts/surfaces/checkout/components/PasswordField.d.ts +3 -14
- package/build/ts/surfaces/checkout/components/PhoneField.d.ts +3 -14
- package/build/ts/surfaces/checkout/components/PressButton.d.ts +2 -8
- package/build/ts/surfaces/checkout/components/Progress.d.ts +3 -5
- package/build/ts/surfaces/checkout/components/ScrollBox.d.ts +1 -3
- package/build/ts/surfaces/checkout/components/Select.d.ts +2 -9
- package/build/ts/surfaces/checkout/components/SkeletonParagraph.d.ts +1 -4
- package/build/ts/surfaces/checkout/components/Spinner.d.ts +1 -3
- package/build/ts/surfaces/checkout/components/Stack.d.ts +1 -3
- package/build/ts/surfaces/checkout/components/Summary.d.ts +1 -4
- package/build/ts/surfaces/checkout/components/Switch.d.ts +2 -9
- package/build/ts/surfaces/checkout/components/Text.d.ts +18 -5
- package/build/ts/surfaces/checkout/components/TextArea.d.ts +2 -9
- package/build/ts/surfaces/checkout/components/TextField.d.ts +3 -14
- package/build/ts/surfaces/checkout/components/Time.d.ts +1 -4
- package/build/ts/surfaces/checkout/components/UnorderedList.d.ts +1 -4
- package/build/ts/surfaces/checkout/components/UrlField.d.ts +3 -14
- package/build/ts/surfaces/checkout/components/components-shared.d.ts +126 -127
- package/build/ts/surfaces/checkout/components/components.d.ts +9 -11
- package/build/ts/surfaces/customer-account/api/docs.d.ts +10 -16
- package/build/ts/surfaces/customer-account/api/docs.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +7 -9
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/shared.d.ts +1 -2
- package/build/ts/surfaces/customer-account/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Abbreviation.d.ts +1 -4
- package/build/ts/surfaces/customer-account/components/Announcement.d.ts +2 -6
- package/build/ts/surfaces/customer-account/components/Badge.d.ts +1 -3
- package/build/ts/surfaces/customer-account/components/Banner.d.ts +2 -6
- package/build/ts/surfaces/customer-account/components/Box.d.ts +1 -3
- package/build/ts/surfaces/customer-account/components/Button.d.ts +2 -8
- package/build/ts/surfaces/customer-account/components/Checkbox.d.ts +2 -9
- package/build/ts/surfaces/customer-account/components/Chip.d.ts +3 -11
- package/build/ts/surfaces/customer-account/components/Choice.d.ts +2 -8
- package/build/ts/surfaces/customer-account/components/ChoiceList.d.ts +2 -9
- package/build/ts/surfaces/customer-account/components/Clickable.d.ts +2 -8
- package/build/ts/surfaces/customer-account/components/ClickableChip.d.ts +4 -15
- package/build/ts/surfaces/customer-account/components/ClipboardItem.d.ts +2 -8
- package/build/ts/surfaces/customer-account/components/ConsentCheckbox.d.ts +8 -9
- package/build/ts/surfaces/customer-account/components/ConsentPhoneField.d.ts +9 -14
- package/build/ts/surfaces/customer-account/components/DateField.d.ts +2 -9
- package/build/ts/surfaces/customer-account/components/DatePicker.d.ts +2 -9
- package/build/ts/surfaces/customer-account/components/Details.d.ts +7 -16
- package/build/ts/surfaces/customer-account/components/DropZone.d.ts +2 -9
- package/build/ts/surfaces/customer-account/components/EmailField.d.ts +3 -14
- package/build/ts/surfaces/customer-account/components/Form.d.ts +2 -9
- package/build/ts/surfaces/customer-account/components/Grid.d.ts +1 -3
- package/build/ts/surfaces/customer-account/components/GridItem.d.ts +1 -3
- package/build/ts/surfaces/customer-account/components/Heading.d.ts +1 -4
- package/build/ts/surfaces/customer-account/components/Link.d.ts +2 -8
- package/build/ts/surfaces/customer-account/components/ListItem.d.ts +1 -4
- package/build/ts/surfaces/customer-account/components/MapMarker.d.ts +3 -6
- package/build/ts/surfaces/customer-account/components/MoneyField.d.ts +2 -9
- package/build/ts/surfaces/customer-account/components/NumberField.d.ts +3 -14
- package/build/ts/surfaces/customer-account/components/Option.d.ts +1 -4
- package/build/ts/surfaces/customer-account/components/OrderedList.d.ts +1 -4
- package/build/ts/surfaces/customer-account/components/Paragraph.d.ts +12 -4
- package/build/ts/surfaces/customer-account/components/PasswordField.d.ts +3 -14
- package/build/ts/surfaces/customer-account/components/PhoneField.d.ts +3 -14
- package/build/ts/surfaces/customer-account/components/PressButton.d.ts +2 -8
- package/build/ts/surfaces/customer-account/components/Progress.d.ts +3 -5
- package/build/ts/surfaces/customer-account/components/ScrollBox.d.ts +1 -3
- package/build/ts/surfaces/customer-account/components/Select.d.ts +2 -9
- package/build/ts/surfaces/customer-account/components/SkeletonParagraph.d.ts +1 -4
- package/build/ts/surfaces/customer-account/components/Spinner.d.ts +1 -3
- package/build/ts/surfaces/customer-account/components/Stack.d.ts +1 -3
- package/build/ts/surfaces/customer-account/components/Summary.d.ts +1 -4
- package/build/ts/surfaces/customer-account/components/Switch.d.ts +2 -9
- package/build/ts/surfaces/customer-account/components/Text.d.ts +18 -5
- package/build/ts/surfaces/customer-account/components/TextArea.d.ts +2 -9
- package/build/ts/surfaces/customer-account/components/TextField.d.ts +3 -14
- package/build/ts/surfaces/customer-account/components/Time.d.ts +1 -4
- package/build/ts/surfaces/customer-account/components/UnorderedList.d.ts +1 -4
- package/build/ts/surfaces/customer-account/components/UrlField.d.ts +3 -14
- package/build/ts/surfaces/customer-account/components/components-shared.d.ts +126 -127
- package/build/ts/surfaces/customer-account/components/components.d.ts +9 -11
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/surfaces/admin/api/generated/generated.ts +76 -0
- package/src/surfaces/admin/api.ts +6 -0
- package/src/surfaces/checkout/api/address-autocomplete/standard.ts +1 -1
- package/src/surfaces/checkout/api/standard/standard.ts +2 -2
- package/src/surfaces/checkout/components/Abbreviation.d.ts +1 -4
- package/src/surfaces/checkout/components/Announcement.d.ts +2 -6
- package/src/surfaces/checkout/components/Badge.d.ts +1 -3
- package/src/surfaces/checkout/components/Banner.d.ts +2 -6
- package/src/surfaces/checkout/components/Box.d.ts +1 -3
- package/src/surfaces/checkout/components/Button.d.ts +2 -8
- package/src/surfaces/checkout/components/Checkbox.d.ts +2 -9
- package/src/surfaces/checkout/components/Chip.d.ts +3 -11
- package/src/surfaces/checkout/components/Choice.d.ts +2 -8
- package/src/surfaces/checkout/components/ChoiceList.d.ts +2 -9
- package/src/surfaces/checkout/components/Clickable.d.ts +2 -8
- package/src/surfaces/checkout/components/ClickableChip.d.ts +4 -15
- package/src/surfaces/checkout/components/ClipboardItem.d.ts +2 -8
- package/src/surfaces/checkout/components/ConsentCheckbox.d.ts +8 -9
- package/src/surfaces/checkout/components/ConsentPhoneField.d.ts +9 -14
- package/src/surfaces/checkout/components/DateField.d.ts +2 -9
- package/src/surfaces/checkout/components/DatePicker.d.ts +2 -9
- package/src/surfaces/checkout/components/Details.d.ts +7 -16
- package/src/surfaces/checkout/components/DropZone.d.ts +2 -9
- package/src/surfaces/checkout/components/EmailField.d.ts +3 -14
- package/src/surfaces/checkout/components/Form.d.ts +2 -9
- package/src/surfaces/checkout/components/Grid.d.ts +1 -3
- package/src/surfaces/checkout/components/GridItem.d.ts +1 -3
- package/src/surfaces/checkout/components/Heading.d.ts +1 -4
- package/src/surfaces/checkout/components/Link.d.ts +2 -8
- package/src/surfaces/checkout/components/ListItem.d.ts +1 -4
- package/src/surfaces/checkout/components/MapMarker.d.ts +3 -6
- package/src/surfaces/checkout/components/MoneyField.d.ts +2 -9
- package/src/surfaces/checkout/components/NumberField.d.ts +3 -14
- package/src/surfaces/checkout/components/Option.d.ts +1 -4
- package/src/surfaces/checkout/components/OrderedList.d.ts +1 -4
- package/src/surfaces/checkout/components/Paragraph.d.ts +12 -4
- package/src/surfaces/checkout/components/PasswordField.d.ts +3 -14
- package/src/surfaces/checkout/components/PhoneField.d.ts +3 -14
- package/src/surfaces/checkout/components/PressButton.d.ts +2 -8
- package/src/surfaces/checkout/components/Progress.d.ts +3 -5
- package/src/surfaces/checkout/components/ScrollBox.d.ts +1 -3
- package/src/surfaces/checkout/components/Select.d.ts +2 -9
- package/src/surfaces/checkout/components/SkeletonParagraph.d.ts +1 -4
- package/src/surfaces/checkout/components/Spinner.d.ts +1 -3
- package/src/surfaces/checkout/components/Stack.d.ts +1 -3
- package/src/surfaces/checkout/components/Summary.d.ts +1 -4
- package/src/surfaces/checkout/components/Switch.d.ts +2 -9
- package/src/surfaces/checkout/components/Text.d.ts +18 -5
- package/src/surfaces/checkout/components/TextArea.d.ts +2 -9
- package/src/surfaces/checkout/components/TextField.d.ts +3 -14
- package/src/surfaces/checkout/components/Time.d.ts +1 -4
- package/src/surfaces/checkout/components/UnorderedList.d.ts +1 -4
- package/src/surfaces/checkout/components/UrlField.d.ts +3 -14
- package/src/surfaces/checkout/components/components-shared.d.ts +126 -127
- package/src/surfaces/checkout/components/components.d.ts +9 -11
- package/src/surfaces/customer-account/api/docs.ts +10 -16
- package/src/surfaces/customer-account/api/order-status/order-status.ts +7 -9
- package/src/surfaces/customer-account/api/shared.ts +1 -2
|
@@ -20,17 +20,15 @@ export interface GlobalProps {
|
|
|
20
20
|
}
|
|
21
21
|
interface AbbreviationProps$1 extends GlobalProps {
|
|
22
22
|
/**
|
|
23
|
-
* The content
|
|
23
|
+
* The abbreviated text content displayed within the abbreviation component. Pair with the `title` attribute to provide the full expansion for accessibility.
|
|
24
24
|
*/
|
|
25
25
|
children?: ComponentChildren;
|
|
26
26
|
/**
|
|
27
|
-
* Defines the full expansion of the abbreviation or acronym.
|
|
27
|
+
* Defines the full expansion of the abbreviation or acronym. Helps user agents and users understand the meaning of the abbreviated text.
|
|
28
28
|
*
|
|
29
|
-
*
|
|
29
|
+
* Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).
|
|
30
30
|
*
|
|
31
31
|
* @default ''
|
|
32
|
-
*
|
|
33
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr
|
|
34
32
|
*/
|
|
35
33
|
title?: string;
|
|
36
34
|
}
|
|
@@ -102,25 +100,25 @@ export interface FocusEventProps {
|
|
|
102
100
|
}
|
|
103
101
|
export interface ToggleEventProps {
|
|
104
102
|
/**
|
|
105
|
-
* A callback
|
|
103
|
+
* A callback fired when the element state changes, after any toggle animations have finished.
|
|
106
104
|
*
|
|
107
105
|
* - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the
|
|
108
106
|
* `newState` property will be set to `open`.
|
|
109
107
|
* - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the
|
|
110
108
|
* `newState` will be `closed`.
|
|
111
109
|
*
|
|
112
|
-
* Learn more about [
|
|
110
|
+
* Learn more about the [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).
|
|
113
111
|
*/
|
|
114
112
|
onAfterToggle?: (event: ToggleEvent$1) => void;
|
|
115
113
|
/**
|
|
116
|
-
* A callback
|
|
114
|
+
* A callback fired immediately when the element state changes, before any animations.
|
|
117
115
|
*
|
|
118
116
|
* - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the
|
|
119
117
|
* `newState` property will be set to `open`.
|
|
120
|
-
* - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the
|
|
118
|
+
* - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the
|
|
121
119
|
* `newState` will be `closed`.
|
|
122
120
|
*
|
|
123
|
-
* Learn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [
|
|
121
|
+
* Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), and the [`newState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState) properties.
|
|
124
122
|
*/
|
|
125
123
|
onToggle?: (event: ToggleEvent$1) => void;
|
|
126
124
|
}
|
|
@@ -907,10 +905,11 @@ export interface DisplayProps {
|
|
|
907
905
|
/**
|
|
908
906
|
* Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).
|
|
909
907
|
*
|
|
910
|
-
* - `auto`:
|
|
911
|
-
* - `none`:
|
|
908
|
+
* - `auto`: The component’s initial value. The actual value depends on the component and context.
|
|
909
|
+
* - `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
|
|
910
|
+
*
|
|
911
|
+
* Learn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).
|
|
912
912
|
*
|
|
913
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/display
|
|
914
913
|
* @default 'auto'
|
|
915
914
|
*/
|
|
916
915
|
display?: MaybeResponsive<"auto" | "none">;
|
|
@@ -955,7 +954,7 @@ export type AccessibilityRole =
|
|
|
955
954
|
* Used to indicate the component is a header.
|
|
956
955
|
*
|
|
957
956
|
* In an HTML host `header` will render a `<header>` element.
|
|
958
|
-
* Learn more about the [`<header>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/
|
|
957
|
+
* Learn more about the [`<header>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/banner_role) in the MDN web docs.
|
|
959
958
|
*/
|
|
960
959
|
| "header"
|
|
961
960
|
/**
|
|
@@ -1060,11 +1059,11 @@ export type AccessibilityRole =
|
|
|
1060
1059
|
| "none";
|
|
1061
1060
|
export interface AccessibilityVisibilityProps {
|
|
1062
1061
|
/**
|
|
1063
|
-
*
|
|
1062
|
+
* Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.
|
|
1064
1063
|
*
|
|
1065
|
-
* - `visible`:
|
|
1066
|
-
* - `hidden`:
|
|
1067
|
-
* - `exclusive`:
|
|
1064
|
+
* - `visible`: The element is visible to all users (both sighted users and screen readers).
|
|
1065
|
+
* - `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.
|
|
1066
|
+
* - `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.
|
|
1068
1067
|
*
|
|
1069
1068
|
* @default 'visible'
|
|
1070
1069
|
*/
|
|
@@ -1535,7 +1534,7 @@ export interface MultipleInputProps extends BaseInputProps {
|
|
|
1535
1534
|
*/
|
|
1536
1535
|
onInput?: (event: Event) => void;
|
|
1537
1536
|
/**
|
|
1538
|
-
* An array of
|
|
1537
|
+
* An array of `value` attributes for the currently selected options.
|
|
1539
1538
|
*
|
|
1540
1539
|
* This is a convenience prop for setting the `selected` prop on child options.
|
|
1541
1540
|
*/
|
|
@@ -1812,11 +1811,11 @@ interface CheckboxProps$1 extends GlobalProps, BaseCheckableProps, FieldErrorPro
|
|
|
1812
1811
|
}
|
|
1813
1812
|
export interface ChipProps$1 {
|
|
1814
1813
|
/**
|
|
1815
|
-
* The
|
|
1814
|
+
* The text label displayed within the chip, which identifies the chip's value or category to users.
|
|
1816
1815
|
*/
|
|
1817
1816
|
children?: ComponentChildren;
|
|
1818
1817
|
/**
|
|
1819
|
-
*
|
|
1818
|
+
* An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label.
|
|
1820
1819
|
*
|
|
1821
1820
|
* @implementation Only `s-icon` is supported.
|
|
1822
1821
|
*/
|
|
@@ -1826,7 +1825,11 @@ export interface ChipProps$1 {
|
|
|
1826
1825
|
*/
|
|
1827
1826
|
accessibilityLabel?: string;
|
|
1828
1827
|
/**
|
|
1829
|
-
*
|
|
1828
|
+
* The color emphasis level that controls visual intensity.
|
|
1829
|
+
*
|
|
1830
|
+
* - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.
|
|
1831
|
+
* - `base`: Primary color for body text, standard UI elements, and general content with good readability.
|
|
1832
|
+
* - `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.
|
|
1830
1833
|
*
|
|
1831
1834
|
* @default 'base'
|
|
1832
1835
|
*/
|
|
@@ -1930,9 +1933,9 @@ interface ClickableProps$1 extends GlobalProps, BaseBoxProps, BaseClickableProps
|
|
|
1930
1933
|
*/
|
|
1931
1934
|
disabled?: BaseClickableProps["disabled"];
|
|
1932
1935
|
/**
|
|
1933
|
-
*
|
|
1934
|
-
*
|
|
1935
|
-
* [
|
|
1936
|
+
* The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
1937
|
+
*
|
|
1938
|
+
* The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
|
|
1936
1939
|
*
|
|
1937
1940
|
* @default ''
|
|
1938
1941
|
*/
|
|
@@ -1940,7 +1943,7 @@ interface ClickableProps$1 extends GlobalProps, BaseBoxProps, BaseClickableProps
|
|
|
1940
1943
|
}
|
|
1941
1944
|
interface ClickableChipProps$1 extends ChipProps$1, GlobalProps {
|
|
1942
1945
|
/**
|
|
1943
|
-
*
|
|
1946
|
+
* A callback fired when the chip is clicked. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).
|
|
1944
1947
|
*/
|
|
1945
1948
|
onClick?: (event: Event) => void;
|
|
1946
1949
|
/**
|
|
@@ -1948,13 +1951,13 @@ interface ClickableChipProps$1 extends ChipProps$1, GlobalProps {
|
|
|
1948
1951
|
*/
|
|
1949
1952
|
href?: string;
|
|
1950
1953
|
/**
|
|
1951
|
-
* Whether the chip
|
|
1954
|
+
* Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.
|
|
1952
1955
|
*
|
|
1953
1956
|
* @default false
|
|
1954
1957
|
*/
|
|
1955
1958
|
removable?: boolean;
|
|
1956
1959
|
/**
|
|
1957
|
-
*
|
|
1960
|
+
* A callback fired when the chip is removed by the user clicking the remove button.
|
|
1958
1961
|
*/
|
|
1959
1962
|
onRemove?: (event: Event) => void;
|
|
1960
1963
|
/**
|
|
@@ -1970,7 +1973,7 @@ interface ClickableChipProps$1 extends ChipProps$1, GlobalProps {
|
|
|
1970
1973
|
*/
|
|
1971
1974
|
hidden?: boolean;
|
|
1972
1975
|
/**
|
|
1973
|
-
*
|
|
1976
|
+
* A callback fired when the chip has fully hidden after a removal animation.
|
|
1974
1977
|
*
|
|
1975
1978
|
* The `hidden` property will be `true` when this event fires.
|
|
1976
1979
|
*
|
|
@@ -1980,7 +1983,7 @@ interface ClickableChipProps$1 extends ChipProps$1, GlobalProps {
|
|
|
1980
1983
|
*/
|
|
1981
1984
|
onAfterHide?: (event: Event) => void;
|
|
1982
1985
|
/**
|
|
1983
|
-
* Disables the chip,
|
|
1986
|
+
* Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.
|
|
1984
1987
|
*
|
|
1985
1988
|
* @default false
|
|
1986
1989
|
*/
|
|
@@ -2041,9 +2044,8 @@ export type AutocompleteAddressGroup = "fax" | "home" | "mobile" | "pager";
|
|
|
2041
2044
|
export type AnyAutocompleteField = "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" | "address-line1" | "address-line2" | "address-line3" | "country-name" | "country" | "current-password" | "email" | "family-name" | "given-name" | "honorific-prefix" | "honorific-suffix" | "language" | "name" | "new-password" | "nickname" | "one-time-code" | "organization-title" | "organization" | "photo" | "postal-code" | "sex" | "street-address" | "transaction-amount" | "transaction-currency" | "url" | "username" | "bday-day" | "bday-month" | "bday-year" | "bday" | "cc-additional-name" | "cc-expiry-month" | "cc-expiry-year" | "cc-expiry" | "cc-family-name" | "cc-given-name" | "cc-name" | "cc-number" | "cc-csc" | "cc-type" | `${AutocompleteAddressGroup} email` | "impp" | `${AutocompleteAddressGroup} impp` | "tel" | "tel-area-code" | "tel-country-code" | "tel-extension" | "tel-local-prefix" | "tel-local-suffix" | "tel-local" | "tel-national" | `${AutocompleteAddressGroup} tel` | `${AutocompleteAddressGroup} tel-area-code` | `${AutocompleteAddressGroup} tel-country-code` | `${AutocompleteAddressGroup} tel-extension` | `${AutocompleteAddressGroup} tel-local-prefix` | `${AutocompleteAddressGroup} tel-local-suffix` | `${AutocompleteAddressGroup} tel-local` | `${AutocompleteAddressGroup} tel-national`;
|
|
2042
2045
|
export type TextAutocompleteField = ExtractStrict<AnyAutocompleteField, "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" | "address-line1" | "address-line2" | "address-line3" | "country-name" | "country" | "family-name" | "given-name" | "honorific-prefix" | "honorific-suffix" | "language" | "name" | "nickname" | "one-time-code" | "organization-title" | "organization" | "postal-code" | "sex" | "street-address" | "transaction-currency" | "username" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-type">;
|
|
2043
2046
|
/**
|
|
2044
|
-
* The
|
|
2045
|
-
*
|
|
2046
|
-
* - `'sms-marketing'`: Represents the policy for SMS marketing consent.
|
|
2047
|
+
* The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.
|
|
2048
|
+
* @publicDocs
|
|
2047
2049
|
*/
|
|
2048
2050
|
export type ConsentPolicy = "sms-marketing";
|
|
2049
2051
|
interface ConsentCheckboxProps$1 extends GlobalProps, CheckboxProps$1 {
|
|
@@ -2055,11 +2057,9 @@ interface ConsentCheckboxProps$1 extends GlobalProps, CheckboxProps$1 {
|
|
|
2055
2057
|
export type PhoneAutocompleteField = ExtractStrict<AnyAutocompleteField, "tel" | "tel-area-code" | "tel-country-code" | "tel-extension" | "tel-local-prefix" | "tel-local-suffix" | "tel-local" | "tel-national" | `${AutocompleteAddressGroup} tel` | `${AutocompleteAddressGroup} tel-area-code` | `${AutocompleteAddressGroup} tel-country-code` | `${AutocompleteAddressGroup} tel-extension` | `${AutocompleteAddressGroup} tel-local-prefix` | `${AutocompleteAddressGroup} tel-local-suffix` | `${AutocompleteAddressGroup} tel-local` | `${AutocompleteAddressGroup} tel-national`>;
|
|
2056
2058
|
interface PhoneFieldProps$1 extends GlobalProps, BaseTextFieldProps, Pick<FieldDecorationProps, "accessory">, AutocompleteProps<PhoneAutocompleteField> {
|
|
2057
2059
|
/**
|
|
2058
|
-
* The type of number to collect.
|
|
2059
|
-
*
|
|
2060
|
-
* Specific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.
|
|
2060
|
+
* The type of phone number to collect. Specific styling may be applied to each type to provide extra guidance to users. No additional validation is performed based on the type.
|
|
2061
2061
|
*
|
|
2062
|
-
* @default ''
|
|
2062
|
+
* @default ''
|
|
2063
2063
|
*/
|
|
2064
2064
|
type?: "mobile" | "";
|
|
2065
2065
|
}
|
|
@@ -2103,9 +2103,7 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
|
|
|
2103
2103
|
*/
|
|
2104
2104
|
type?: "single" | "multiple" | "range";
|
|
2105
2105
|
/**
|
|
2106
|
-
*
|
|
2107
|
-
*
|
|
2108
|
-
* A comma-separated list of dates, date ranges. Whitespace is allowed after commas.
|
|
2106
|
+
* Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.
|
|
2109
2107
|
*
|
|
2110
2108
|
* The default `''` allows all dates.
|
|
2111
2109
|
*
|
|
@@ -2156,7 +2154,7 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
|
|
|
2156
2154
|
*/
|
|
2157
2155
|
disallow?: string;
|
|
2158
2156
|
/**
|
|
2159
|
-
*
|
|
2157
|
+
* Restricts which days of the week the user can select. Only dates that fall on an allowed day AND pass the `allow`/`disallow` filters are selectable. For example, setting `allowedDays` to `'mon, wed, fri'` with `allow` set to `'2024-06'` restricts selection to Mondays, Wednesdays, and Fridays in June 2024.
|
|
2160
2158
|
*
|
|
2161
2159
|
* A comma-separated list of days. Whitespace is allowed after commas.
|
|
2162
2160
|
*
|
|
@@ -2236,47 +2234,42 @@ interface DateFieldProps$1 extends GlobalProps, BaseTextFieldProps, Pick<DatePic
|
|
|
2236
2234
|
*
|
|
2237
2235
|
* Disallowed dates are considered invalid.
|
|
2238
2236
|
*
|
|
2239
|
-
*
|
|
2240
|
-
*
|
|
2241
|
-
* The field is **not** validated on every change to the input. Once the buyer has signalled that
|
|
2242
|
-
* they have finished editing the field (typically, by blurring the field), the field gets validated and the callback is run if the value is invalid.
|
|
2237
|
+
* This callback fires only when the user finishes editing the date, right after the `change` callback.
|
|
2238
|
+
* The field isn't validated on every change to the input. Once the user has finished editing the field (typically by blurring it), the field is validated and the callback fires if the value is invalid.
|
|
2243
2239
|
*/
|
|
2244
2240
|
onInvalid?: (event: Event) => void;
|
|
2245
2241
|
}
|
|
2246
2242
|
export type DateAutocompleteField = ExtractStrict<AnyAutocompleteField, "bday" | "bday-day" | "bday-month" | "bday-year" | "cc-expiry" | "cc-expiry-month" | "cc-expiry-year">;
|
|
2247
2243
|
interface DetailsProps$1 extends GlobalProps, ToggleEventProps {
|
|
2248
2244
|
/**
|
|
2249
|
-
* The content
|
|
2245
|
+
* The content displayed within the details component, which creates a collapsible disclosure widget.
|
|
2250
2246
|
*
|
|
2251
|
-
*
|
|
2247
|
+
* Learn more about the [details element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details).
|
|
2252
2248
|
*/
|
|
2253
2249
|
children?: ComponentChildren;
|
|
2254
2250
|
/**
|
|
2255
|
-
*
|
|
2251
|
+
* The `name` attribute for the element. Use this to create multiple named disclosure groups where only one can be open at a time.
|
|
2256
2252
|
*
|
|
2257
|
-
*
|
|
2258
|
-
*
|
|
2259
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details#multiple_named_disclosure_boxes
|
|
2253
|
+
* Learn more about [multiple named disclosure boxes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details#multiple_named_disclosure_boxes).
|
|
2260
2254
|
*/
|
|
2261
2255
|
name?: string;
|
|
2262
2256
|
/**
|
|
2263
|
-
* Whether the element is open.
|
|
2264
|
-
*
|
|
2265
|
-
* This does not reflect to any attribute.
|
|
2257
|
+
* Whether the element is currently open and showing its content. Use this for controlled behavior where you manage the open state yourself.
|
|
2266
2258
|
*
|
|
2267
2259
|
* @default false
|
|
2268
2260
|
*/
|
|
2269
2261
|
open?: boolean;
|
|
2270
2262
|
/**
|
|
2271
|
-
*
|
|
2272
|
-
*
|
|
2273
|
-
* This reflects to the `open` attribute.
|
|
2263
|
+
* Whether the element should be open when it first renders. Use this for uncontrolled behavior where the component manages its own open state after the initial render.
|
|
2274
2264
|
*
|
|
2275
2265
|
* @default false
|
|
2276
2266
|
*/
|
|
2277
2267
|
defaultOpen?: boolean;
|
|
2278
2268
|
/**
|
|
2279
|
-
* Sets the transition between the
|
|
2269
|
+
* Sets the animation transition between the open and closed states.
|
|
2270
|
+
*
|
|
2271
|
+
* - `none`: Disables all transition animations.
|
|
2272
|
+
* - `auto`: Uses the default transition animation.
|
|
2280
2273
|
*
|
|
2281
2274
|
* @default 'auto'
|
|
2282
2275
|
*/
|
|
@@ -2481,29 +2474,47 @@ interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole {
|
|
|
2481
2474
|
}
|
|
2482
2475
|
export interface BaseTypographyProps {
|
|
2483
2476
|
/**
|
|
2484
|
-
*
|
|
2477
|
+
* The color emphasis level that controls visual intensity.
|
|
2478
|
+
*
|
|
2479
|
+
* - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.
|
|
2480
|
+
* - `base`: Primary color for body text, standard UI elements, and general content with good readability.
|
|
2481
|
+
* - `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.
|
|
2485
2482
|
*
|
|
2486
2483
|
* @default 'base'
|
|
2487
2484
|
*/
|
|
2488
2485
|
color?: ColorKeyword;
|
|
2489
2486
|
/**
|
|
2490
|
-
*
|
|
2487
|
+
* The semantic meaning and color treatment of the component.
|
|
2488
|
+
*
|
|
2489
|
+
* - `auto`: Automatically determined based on context.
|
|
2490
|
+
* - `neutral`: General information without specific intent.
|
|
2491
|
+
* - `info`: Informational content or helpful tips.
|
|
2492
|
+
* - `success`: Positive outcomes or successful states.
|
|
2493
|
+
* - `caution`: Advisory notices that need attention.
|
|
2494
|
+
* - `warning`: Important warnings about potential issues.
|
|
2495
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
2496
|
+
* - `accent`: Highlighted or promotional content.
|
|
2497
|
+
* - `custom`: Custom styling controlled by your theme.
|
|
2491
2498
|
*
|
|
2492
2499
|
* @default 'auto'
|
|
2493
2500
|
*/
|
|
2494
2501
|
tone?: ToneKeyword;
|
|
2495
2502
|
/**
|
|
2496
|
-
*
|
|
2503
|
+
* The rendering style for numbers in the font.
|
|
2497
2504
|
*
|
|
2498
|
-
*
|
|
2505
|
+
* - `auto`: Inherits the setting from the parent element.
|
|
2506
|
+
* - `normal`: Uses the font's default numeric glyphs.
|
|
2507
|
+
* - `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.
|
|
2499
2508
|
*
|
|
2500
|
-
*
|
|
2509
|
+
* Learn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).
|
|
2510
|
+
*
|
|
2511
|
+
* @default 'auto'
|
|
2501
2512
|
*/
|
|
2502
2513
|
fontVariantNumeric?: "auto" | "normal" | "tabular-nums";
|
|
2503
2514
|
/**
|
|
2504
|
-
*
|
|
2505
|
-
*
|
|
2506
|
-
* [
|
|
2515
|
+
* The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
2516
|
+
*
|
|
2517
|
+
* The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
|
|
2507
2518
|
*
|
|
2508
2519
|
* It is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.
|
|
2509
2520
|
*
|
|
@@ -2513,12 +2524,12 @@ export interface BaseTypographyProps {
|
|
|
2513
2524
|
/**
|
|
2514
2525
|
* Indicates the directionality of the element’s text.
|
|
2515
2526
|
*
|
|
2516
|
-
* - `ltr`: languages written from left to right (such as English)
|
|
2517
|
-
* - `rtl`: languages written from right to left (such as Arabic)
|
|
2518
|
-
* - `auto`:
|
|
2519
|
-
* - `
|
|
2527
|
+
* - `ltr`: The languages written from left to right (such as English).
|
|
2528
|
+
* - `rtl`: The languages written from right to left (such as Arabic).
|
|
2529
|
+
* - `auto`: The user agent determines the direction based on the content.
|
|
2530
|
+
* - `""`: The direction is inherited from parent elements (equivalent to not setting the attribute).
|
|
2520
2531
|
*
|
|
2521
|
-
*
|
|
2532
|
+
* Learn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).
|
|
2522
2533
|
*
|
|
2523
2534
|
* @default ''
|
|
2524
2535
|
*/
|
|
@@ -2526,9 +2537,9 @@ export interface BaseTypographyProps {
|
|
|
2526
2537
|
}
|
|
2527
2538
|
export interface BlockTypographyProps {
|
|
2528
2539
|
/**
|
|
2529
|
-
*
|
|
2540
|
+
* The maximum number of lines to display before truncating the text content.
|
|
2530
2541
|
*
|
|
2531
|
-
*
|
|
2542
|
+
* Learn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).
|
|
2532
2543
|
*
|
|
2533
2544
|
* @default Infinity - no truncation is applied
|
|
2534
2545
|
*/
|
|
@@ -2536,19 +2547,16 @@ export interface BlockTypographyProps {
|
|
|
2536
2547
|
}
|
|
2537
2548
|
interface HeadingProps$1 extends GlobalProps, AccessibilityVisibilityProps, BlockTypographyProps {
|
|
2538
2549
|
/**
|
|
2539
|
-
* The
|
|
2550
|
+
* The heading text displayed within the heading component, which provides a title or section header for content.
|
|
2540
2551
|
*/
|
|
2541
2552
|
children?: ComponentChildren;
|
|
2542
2553
|
/**
|
|
2543
|
-
*
|
|
2554
|
+
* The semantic meaning of the component’s content. When set,
|
|
2544
2555
|
* the role will be used by assistive technologies to help users
|
|
2545
2556
|
* navigate the page.
|
|
2546
2557
|
*
|
|
2547
|
-
* - `
|
|
2548
|
-
* - `
|
|
2549
|
-
* and will prevent the element’s implicit ARIA semantics from
|
|
2550
|
-
* being exposed to the accessibility tree.
|
|
2551
|
-
* - `none`: a synonym for the `presentation` role.
|
|
2558
|
+
* - `presentation`: Removes semantic meaning, making the element purely decorative and ignored by screen readers.
|
|
2559
|
+
* - `none`: Completely hides the element and its content from assistive technologies.
|
|
2552
2560
|
*
|
|
2553
2561
|
* @default 'heading'
|
|
2554
2562
|
*
|
|
@@ -2730,7 +2738,7 @@ interface LinkProps$1 extends GlobalProps, LinkBehaviorProps {
|
|
|
2730
2738
|
}
|
|
2731
2739
|
interface ListItemProps$1 extends GlobalProps {
|
|
2732
2740
|
/**
|
|
2733
|
-
* The content
|
|
2741
|
+
* The content displayed within the list item, which represents a single entry in an ordered or unordered list.
|
|
2734
2742
|
*/
|
|
2735
2743
|
children?: ComponentChildren;
|
|
2736
2744
|
}
|
|
@@ -2946,11 +2954,11 @@ interface OrderedListProps$1 extends GlobalProps {
|
|
|
2946
2954
|
}
|
|
2947
2955
|
interface ParagraphProps$1 extends GlobalProps, BaseTypographyProps, BlockTypographyProps, AccessibilityVisibilityProps {
|
|
2948
2956
|
/**
|
|
2949
|
-
* The content
|
|
2957
|
+
* The paragraph text content displayed within the paragraph component, which presents a block of related text with appropriate styling.
|
|
2950
2958
|
*/
|
|
2951
2959
|
children?: ComponentChildren;
|
|
2952
2960
|
/**
|
|
2953
|
-
*
|
|
2961
|
+
* The semantic type and styling treatment for the paragraph content.
|
|
2954
2962
|
*
|
|
2955
2963
|
* Other presentation properties on `s-paragraph` override the default styling.
|
|
2956
2964
|
*
|
|
@@ -2960,20 +2968,19 @@ interface ParagraphProps$1 extends GlobalProps, BaseTypographyProps, BlockTypogr
|
|
|
2960
2968
|
}
|
|
2961
2969
|
export type ParagraphType =
|
|
2962
2970
|
/**
|
|
2963
|
-
*
|
|
2971
|
+
* A semantic type that indicates the text is a structural grouping of related content.
|
|
2964
2972
|
*
|
|
2965
|
-
* In an HTML host, the text will be rendered in an `<p>` element.
|
|
2966
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p
|
|
2973
|
+
* In an HTML host, the text will be rendered in an `<p>` element. Learn more about the [p element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p).
|
|
2967
2974
|
*/
|
|
2968
2975
|
"paragraph"
|
|
2969
2976
|
/**
|
|
2970
|
-
*
|
|
2977
|
+
* A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand.
|
|
2978
|
+
*
|
|
2971
2979
|
* It can be used for secondary content but also for disclaimers, terms and conditions, or legal information.
|
|
2972
2980
|
*
|
|
2973
2981
|
* Surfaces should apply a smaller font size than the default size.
|
|
2974
2982
|
*
|
|
2975
|
-
* In an HTML host, the text will be rendered in a `<small>` element.
|
|
2976
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small
|
|
2983
|
+
* In an HTML host, the text will be rendered in a `<small>` element. Learn more about the [small element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small).
|
|
2977
2984
|
*/
|
|
2978
2985
|
| "small";
|
|
2979
2986
|
interface PasswordFieldProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLengthProps, AutocompleteProps<PasswordAutocompleteField> {
|
|
@@ -3059,13 +3066,13 @@ interface ProgressProps$1 extends GlobalProps {
|
|
|
3059
3066
|
*/
|
|
3060
3067
|
tone?: ToneKeyword;
|
|
3061
3068
|
/**
|
|
3062
|
-
* How much of the task has been completed. Must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.
|
|
3069
|
+
* How much of the task has been completed. Must be a valid floating point number between `0` and `max`, or between `0` and `1` if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.
|
|
3063
3070
|
*
|
|
3064
3071
|
* Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).
|
|
3065
3072
|
*/
|
|
3066
3073
|
value?: number;
|
|
3067
3074
|
/**
|
|
3068
|
-
* The total amount of work the task requires. Must be a value greater than 0 and a valid floating point number.
|
|
3075
|
+
* The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.
|
|
3069
3076
|
*
|
|
3070
3077
|
* Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).
|
|
3071
3078
|
*
|
|
@@ -3199,7 +3206,7 @@ interface SheetProps$1 extends BaseOverlayProps, BaseOverlayMethods, ToggleEvent
|
|
|
3199
3206
|
/**
|
|
3200
3207
|
* Adjust the padding of all edges.
|
|
3201
3208
|
*
|
|
3202
|
-
* - `base`: Applies padding that is appropriate for the element.
|
|
3209
|
+
* - `base`: Applies padding that is appropriate for the element. This might result in no padding if Shopify determines that is the right design decision for a particular context.
|
|
3203
3210
|
* - `none`: Removes all padding from the element. This can be useful when elements inside the sheet need to span to the edge of the sheet. For example, a full-width image. In this case, rely on box with a padding of `base` to bring back the desired padding for the rest of the content.
|
|
3204
3211
|
*
|
|
3205
3212
|
* @default 'base'
|
|
@@ -3267,12 +3274,12 @@ interface StackProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps {
|
|
|
3267
3274
|
}
|
|
3268
3275
|
interface SummaryProps$1 extends GlobalProps {
|
|
3269
3276
|
/**
|
|
3270
|
-
* The content
|
|
3277
|
+
* The content displayed as the clickable label of the disclosure widget. This label is always visible and users interact with it to toggle the details content open or closed.
|
|
3271
3278
|
*
|
|
3272
|
-
* Interactive content is disallowed. For example, you can use
|
|
3279
|
+
* Interactive content is disallowed. For example, you can use an `s-text` element for extra formatting but
|
|
3273
3280
|
* elements like buttons and fields are not allowed.
|
|
3274
3281
|
*
|
|
3275
|
-
*
|
|
3282
|
+
* Learn more about the [summary element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/summary).
|
|
3276
3283
|
*
|
|
3277
3284
|
* @implementation Surfaces may apply styling to this element. An icon suggesting the state (open or closed) of the
|
|
3278
3285
|
* details element is recommended.
|
|
@@ -3285,13 +3292,13 @@ interface SwitchProps$1 extends GlobalProps, BaseCheckableProps, BasicFieldProps
|
|
|
3285
3292
|
}
|
|
3286
3293
|
interface TextProps$1 extends GlobalProps, AccessibilityVisibilityProps, BaseTypographyProps, DisplayProps, Pick<InteractionProps, "interestFor"> {
|
|
3287
3294
|
/**
|
|
3288
|
-
* The content
|
|
3295
|
+
* The text content displayed within the text component, which applies semantic meaning and styling appropriate to the specified text type.
|
|
3289
3296
|
*/
|
|
3290
3297
|
children?: ComponentChildren;
|
|
3291
3298
|
/**
|
|
3292
|
-
*
|
|
3299
|
+
* The semantic type and styling treatment for the text content.
|
|
3293
3300
|
*
|
|
3294
|
-
* Other presentation properties on
|
|
3301
|
+
* Other presentation properties on `s-text` override the default styling.
|
|
3295
3302
|
*
|
|
3296
3303
|
* @default 'generic'
|
|
3297
3304
|
*/
|
|
@@ -3299,7 +3306,7 @@ interface TextProps$1 extends GlobalProps, AccessibilityVisibilityProps, BaseTyp
|
|
|
3299
3306
|
}
|
|
3300
3307
|
export type TextType =
|
|
3301
3308
|
/**
|
|
3302
|
-
*
|
|
3309
|
+
* A semantic type that indicates the text is contact information. Typically used for addresses.
|
|
3303
3310
|
*
|
|
3304
3311
|
* This must have `inline` layout (despite the default being `block` in HTML hosts).
|
|
3305
3312
|
*
|
|
@@ -3309,65 +3316,60 @@ export type TextType =
|
|
|
3309
3316
|
*
|
|
3310
3317
|
* @implementation vertical alignment should be `baseline` (`vertical-align: baseline`)
|
|
3311
3318
|
*
|
|
3312
|
-
*
|
|
3319
|
+
* Learn more about the [address element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address).
|
|
3313
3320
|
*/
|
|
3314
3321
|
"address"
|
|
3315
3322
|
/**
|
|
3316
|
-
*
|
|
3323
|
+
* A semantic type that indicates the text is no longer accurate or no longer relevant. One such use-case is discounted prices.
|
|
3317
3324
|
*
|
|
3318
3325
|
* Surfaces should apply styling to this type to suggest its content no longer applies.
|
|
3319
3326
|
*
|
|
3320
|
-
* In an HTML host, the text will be rendered in a `<s>` element.
|
|
3321
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s
|
|
3327
|
+
* In an HTML host, the text will be rendered in a `<s>` element. Learn more about the [s element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s).
|
|
3322
3328
|
*/
|
|
3323
3329
|
| "redundant"
|
|
3324
3330
|
/**
|
|
3325
|
-
*
|
|
3331
|
+
* A semantic type that indicates the text is marked or highlighted and relevant to the user’s current action.
|
|
3326
3332
|
* One such use-case is to indicate the characters that matched a search query.
|
|
3327
3333
|
*
|
|
3328
3334
|
* Surfaces should apply styling to this type to draw attention to the content.
|
|
3329
3335
|
*
|
|
3330
|
-
* In an HTML host, the text will be rendered in a `<mark>` element.
|
|
3331
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark
|
|
3336
|
+
* In an HTML host, the text will be rendered in a `<mark>` element. Learn more about the [mark element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark).
|
|
3332
3337
|
*/
|
|
3333
3338
|
| "mark"
|
|
3334
3339
|
/**
|
|
3335
|
-
*
|
|
3340
|
+
* A semantic type that indicates emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text.
|
|
3336
3341
|
*
|
|
3337
3342
|
* Surfaces should apply styling to this type to distinguish it from surrounding text. Italicization is a common choice, but not required.
|
|
3338
3343
|
*
|
|
3339
|
-
* In an HTML host, the text will be rendered in an `<em>` element.
|
|
3340
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em
|
|
3344
|
+
* In an HTML host, the text will be rendered in an `<em>` element. Learn more about the [em element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em).
|
|
3341
3345
|
*/
|
|
3342
3346
|
| "emphasis"
|
|
3343
3347
|
/**
|
|
3344
|
-
*
|
|
3345
|
-
*
|
|
3346
|
-
* instead of representing its semantic meaning.
|
|
3348
|
+
* A semantic type that indicates an offset from the normal prose of the text.
|
|
3349
|
+
*
|
|
3350
|
+
* Typically used to indicate a foreign word, fictional character thoughts, or when the text refers to the definition of a word instead of representing its semantic meaning.
|
|
3347
3351
|
*
|
|
3348
3352
|
* Surfaces should italicize this content by default.
|
|
3349
3353
|
*
|
|
3350
|
-
* In an HTML host, the text will be rendered in a `<i>` tag.
|
|
3351
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i
|
|
3354
|
+
* In an HTML host, the text will be rendered in a `<i>` tag. Learn more about the [i element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i).
|
|
3352
3355
|
*/
|
|
3353
3356
|
| "offset"
|
|
3354
3357
|
/**
|
|
3355
|
-
*
|
|
3358
|
+
* A semantic type that indicates strong importance, seriousness, or urgency.
|
|
3356
3359
|
*
|
|
3357
3360
|
* Surfaces should render this content bold by default.
|
|
3358
3361
|
*
|
|
3359
|
-
* In an HTML host, the text will be rendered in a `<strong>` tag.
|
|
3360
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong
|
|
3362
|
+
* In an HTML host, the text will be rendered in a `<strong>` tag. Learn more about the [strong element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong).
|
|
3361
3363
|
*/
|
|
3362
3364
|
| "strong"
|
|
3363
3365
|
/**
|
|
3364
|
-
*
|
|
3366
|
+
* A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand.
|
|
3367
|
+
*
|
|
3365
3368
|
* It can be used for secondary content but also for disclaimers, terms and conditions, or legal information.
|
|
3366
3369
|
*
|
|
3367
3370
|
* Surfaces should apply a smaller font size than the default size.
|
|
3368
3371
|
*
|
|
3369
|
-
* In an HTML host, the text will be rendered in a `<small>` element.
|
|
3370
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small
|
|
3372
|
+
* In an HTML host, the text will be rendered in a `<small>` element. Learn more about the [small element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small).
|
|
3371
3373
|
*/
|
|
3372
3374
|
| "small"
|
|
3373
3375
|
/**
|
|
@@ -3375,8 +3377,7 @@ export type TextType =
|
|
|
3375
3377
|
*
|
|
3376
3378
|
* Surfaces must not apply any default styling to this type.
|
|
3377
3379
|
*
|
|
3378
|
-
* In an HTML host, the text will be rendered in a `<span>` tag.
|
|
3379
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span
|
|
3380
|
+
* In an HTML host, the text will be rendered in a `<span>` tag. Learn more about the [span element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span).
|
|
3380
3381
|
*/
|
|
3381
3382
|
| "generic";
|
|
3382
3383
|
interface TextAreaProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLengthProps, AutocompleteProps<TextAutocompleteField> {
|
|
@@ -3391,15 +3392,13 @@ interface TextFieldProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLength
|
|
|
3391
3392
|
}
|
|
3392
3393
|
interface TimeProps$1 extends GlobalProps {
|
|
3393
3394
|
/**
|
|
3394
|
-
* The content
|
|
3395
|
+
* The text content displayed within the time component, representing a human-readable date or time value.
|
|
3395
3396
|
*/
|
|
3396
3397
|
children?: ComponentChildren;
|
|
3397
3398
|
/**
|
|
3398
|
-
*
|
|
3399
|
-
*
|
|
3400
|
-
* It must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).
|
|
3399
|
+
* The machine-readable date and/or time value for the element. Use this to provide a datetime string that browsers, search engines, and assistive technologies can parse for improved semantics and functionality.
|
|
3401
3400
|
*
|
|
3402
|
-
*
|
|
3401
|
+
* The value must be a [valid datetime string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values), such as `2024-01-15`, `14:30`, or `2024-01-15T14:30:00`.
|
|
3403
3402
|
*
|
|
3404
3403
|
* @default ''
|
|
3405
3404
|
*/
|