@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
|
@@ -56,20 +56,19 @@ declare module 'preact' {
|
|
|
56
56
|
}
|
|
57
57
|
|
|
58
58
|
declare const tagName = "s-consent-checkbox";
|
|
59
|
-
/**
|
|
60
|
-
* Configure the following properties on the consent checkbox component.
|
|
61
|
-
* @publicDocs
|
|
62
|
-
*/
|
|
59
|
+
/** @publicDocs */
|
|
63
60
|
export interface ConsentCheckboxElementProps extends Pick<ConsentCheckboxProps$1, 'accessibilityLabel' | 'checked' | 'command' | 'commandFor' | 'defaultChecked' | 'disabled' | 'error' | 'id' | 'label' | 'name' | 'policy' | 'value'> {
|
|
64
61
|
command?: Extract<ConsentCheckboxProps$1['command'], '--auto' | '--show' | '--hide' | '--toggle'>;
|
|
62
|
+
/**
|
|
63
|
+
* 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.
|
|
64
|
+
*
|
|
65
|
+
* - `sms-marketing`: Represents the policy for SMS marketing consent.
|
|
66
|
+
*/
|
|
67
|
+
policy?: ConsentCheckboxProps$1['policy'];
|
|
65
68
|
}
|
|
66
69
|
export interface ConsentCheckboxEvents extends Pick<CheckboxEvents, 'onChange'> {
|
|
67
70
|
}
|
|
68
|
-
/**
|
|
69
|
-
* The consent checkbox component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
70
|
-
*
|
|
71
|
-
* @publicDocs
|
|
72
|
-
*/
|
|
71
|
+
/** @publicDocs */
|
|
73
72
|
export interface ConsentCheckboxElementEvents {
|
|
74
73
|
/**
|
|
75
74
|
* A callback fired when the consent checkbox value changes.
|
|
@@ -69,24 +69,23 @@ declare module 'preact' {
|
|
|
69
69
|
}
|
|
70
70
|
|
|
71
71
|
declare const tagName = "s-consent-phone-field";
|
|
72
|
-
/**
|
|
73
|
-
* Configure the following properties on the consent phone field component.
|
|
74
|
-
* @publicDocs
|
|
75
|
-
*/
|
|
72
|
+
/** @publicDocs */
|
|
76
73
|
export interface ConsentPhoneFieldElementProps extends Pick<ConsentPhoneFieldProps$1, 'autocomplete' | 'defaultValue' | 'disabled' | 'error' | 'id' | 'label' | 'labelAccessibilityVisibility' | 'name' | 'policy' | 'readOnly' | 'required' | 'type' | 'value'> {
|
|
77
74
|
/**
|
|
78
75
|
* @deprecated Use `label` instead.
|
|
79
76
|
* @private
|
|
80
77
|
*/
|
|
81
78
|
placeholder?: string;
|
|
79
|
+
/**
|
|
80
|
+
* 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.
|
|
81
|
+
*
|
|
82
|
+
* - `sms-marketing`: Represents the policy for SMS marketing consent.
|
|
83
|
+
*/
|
|
84
|
+
policy?: ConsentPhoneFieldProps$1['policy'];
|
|
82
85
|
}
|
|
83
86
|
export interface ConsentPhoneFieldEvents extends Pick<PhoneFieldEvents, 'onBlur' | 'onChange' | 'onFocus' | 'onInput'> {
|
|
84
87
|
}
|
|
85
|
-
/**
|
|
86
|
-
* The consent phone field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
87
|
-
*
|
|
88
|
-
* @publicDocs
|
|
89
|
-
*/
|
|
88
|
+
/** @publicDocs */
|
|
90
89
|
export interface ConsentPhoneFieldElementEvents {
|
|
91
90
|
/**
|
|
92
91
|
* A callback fired when the consent phone field loses focus.
|
|
@@ -119,11 +118,7 @@ export interface ConsentPhoneFieldElement extends ConsentPhoneFieldElementProps,
|
|
|
119
118
|
onfocus: ConsentPhoneFieldEvents['onFocus'];
|
|
120
119
|
oninput: ConsentPhoneFieldEvents['onInput'];
|
|
121
120
|
}
|
|
122
|
-
/**
|
|
123
|
-
* The consent phone field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
124
|
-
*
|
|
125
|
-
* @publicDocs
|
|
126
|
-
*/
|
|
121
|
+
/** @publicDocs */
|
|
127
122
|
export interface ConsentPhoneFieldElementSlots {
|
|
128
123
|
/**
|
|
129
124
|
* Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.
|
|
@@ -32,10 +32,7 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
|
|
|
32
32
|
}) | null;
|
|
33
33
|
|
|
34
34
|
declare const tagName = "s-date-field";
|
|
35
|
-
/**
|
|
36
|
-
* Configure the following properties on the date field component.
|
|
37
|
-
* @publicDocs
|
|
38
|
-
*/
|
|
35
|
+
/** @publicDocs */
|
|
39
36
|
export interface DateFieldElementProps extends Pick<DateFieldProps$1, 'allow' | 'allowDays' | 'autocomplete' | 'defaultValue' | 'defaultView' | 'disabled' | 'disallow' | 'disallowDays' | 'error' | 'id' | 'label' | 'name' | 'readOnly' | 'required' | 'value' | 'view'> {
|
|
40
37
|
/**
|
|
41
38
|
* @deprecated Use `label` instead.
|
|
@@ -45,11 +42,7 @@ export interface DateFieldElementProps extends Pick<DateFieldProps$1, 'allow' |
|
|
|
45
42
|
}
|
|
46
43
|
export interface DateFieldEvents extends Pick<DateFieldProps$1, 'onBlur' | 'onChange' | 'onFocus' | 'onInput' | 'onInvalid' | 'onViewChange'> {
|
|
47
44
|
}
|
|
48
|
-
/**
|
|
49
|
-
* The date field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
50
|
-
*
|
|
51
|
-
* @publicDocs
|
|
52
|
-
*/
|
|
45
|
+
/** @publicDocs */
|
|
53
46
|
export interface DateFieldElementEvents {
|
|
54
47
|
/**
|
|
55
48
|
* A callback fired when the date field loses focus.
|
|
@@ -32,19 +32,12 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
|
|
|
32
32
|
}) | null;
|
|
33
33
|
|
|
34
34
|
declare const tagName = "s-date-picker";
|
|
35
|
-
/**
|
|
36
|
-
* Configure the following properties on the date picker component.
|
|
37
|
-
* @publicDocs
|
|
38
|
-
*/
|
|
35
|
+
/** @publicDocs */
|
|
39
36
|
export interface DatePickerElementProps extends Pick<DatePickerProps$1, 'allow' | 'allowDays' | 'defaultValue' | 'defaultView' | 'disabled' | 'disallow' | 'disallowDays' | 'id' | 'name' | 'type' | 'value' | 'view'> {
|
|
40
37
|
}
|
|
41
38
|
export interface DatePickerEvents extends Pick<DatePickerProps$1, 'onBlur' | 'onChange' | 'onFocus' | 'onInput' | 'onViewChange'> {
|
|
42
39
|
}
|
|
43
|
-
/**
|
|
44
|
-
* The date picker component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
45
|
-
*
|
|
46
|
-
* @publicDocs
|
|
47
|
-
*/
|
|
40
|
+
/** @publicDocs */
|
|
48
41
|
export interface DatePickerElementEvents {
|
|
49
42
|
/**
|
|
50
43
|
* A callback fired when the date picker loses focus.
|
|
@@ -43,42 +43,33 @@ export interface ToggleArgumentsEvent {
|
|
|
43
43
|
}
|
|
44
44
|
|
|
45
45
|
declare const tagName = "s-details";
|
|
46
|
-
/**
|
|
47
|
-
* The element props interface for the Details component.
|
|
48
|
-
* @publicDocs
|
|
49
|
-
*/
|
|
46
|
+
/** @publicDocs */
|
|
50
47
|
export interface DetailsElementProps extends Pick<DetailsProps$1, 'defaultOpen' | 'id' | 'open' | 'toggleTransition'> {
|
|
51
48
|
}
|
|
52
49
|
export interface DetailsEvents extends Pick<DetailsProps$1, 'onToggle' | 'onAfterToggle'> {
|
|
53
50
|
}
|
|
54
|
-
/**
|
|
55
|
-
* The events interface for the Details component.
|
|
56
|
-
* @publicDocs
|
|
57
|
-
*/
|
|
51
|
+
/** @publicDocs */
|
|
58
52
|
export interface DetailsElementEvents {
|
|
59
53
|
/**
|
|
60
|
-
*
|
|
54
|
+
* A callback fired immediately when the element state changes, before any animations.
|
|
61
55
|
*
|
|
62
56
|
* - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the
|
|
63
57
|
* `newState` property will be set to `open`.
|
|
64
|
-
* - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the
|
|
58
|
+
* - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the
|
|
65
59
|
* `newState` will be `closed`.
|
|
66
60
|
*
|
|
67
|
-
*
|
|
68
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState
|
|
69
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState
|
|
61
|
+
* 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.
|
|
70
62
|
*/
|
|
71
63
|
toggle?: CallbackEventListener<typeof tagName, ToggleArgumentsEvent>;
|
|
72
64
|
/**
|
|
73
|
-
*
|
|
65
|
+
* A callback fired when the element state changes, after any toggle animations have finished.
|
|
74
66
|
*
|
|
75
67
|
* - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the
|
|
76
68
|
* `newState` property will be set to `open`.
|
|
77
69
|
* - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the
|
|
78
70
|
* `newState` will be `closed`.
|
|
79
71
|
*
|
|
80
|
-
*
|
|
81
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState
|
|
72
|
+
* 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).
|
|
82
73
|
*/
|
|
83
74
|
aftertoggle?: CallbackEventListener<typeof tagName, ToggleArgumentsEvent>;
|
|
84
75
|
}
|
|
@@ -32,19 +32,12 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
|
|
|
32
32
|
}) | null;
|
|
33
33
|
|
|
34
34
|
declare const tagName = "s-drop-zone";
|
|
35
|
-
/**
|
|
36
|
-
* Configure the following properties on the drop zone component.
|
|
37
|
-
* @publicDocs
|
|
38
|
-
*/
|
|
35
|
+
/** @publicDocs */
|
|
39
36
|
export interface DropZoneElementProps extends Pick<DropZoneProps$1, 'accept' | 'accessibilityLabel' | 'disabled' | 'error' | 'id' | 'label' | 'multiple' | 'name' | 'required' | 'value'> {
|
|
40
37
|
}
|
|
41
38
|
export interface DropZoneEvents extends Pick<DropZoneProps$1, 'onDropRejected' | 'onInput' | 'onChange'> {
|
|
42
39
|
}
|
|
43
|
-
/**
|
|
44
|
-
* The drop zone component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
45
|
-
*
|
|
46
|
-
* @publicDocs
|
|
47
|
-
*/
|
|
40
|
+
/** @publicDocs */
|
|
48
41
|
export interface DropZoneElementEvents {
|
|
49
42
|
/**
|
|
50
43
|
* A callback fired when files are rejected based on the `accept` prop.
|
|
@@ -38,10 +38,7 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
|
|
|
38
38
|
}) | null;
|
|
39
39
|
|
|
40
40
|
declare const tagName = "s-email-field";
|
|
41
|
-
/**
|
|
42
|
-
* Configure the following properties on the email field component.
|
|
43
|
-
* @publicDocs
|
|
44
|
-
*/
|
|
41
|
+
/** @publicDocs */
|
|
45
42
|
export interface EmailFieldElementProps extends Pick<EmailFieldProps$1, 'autocomplete' | 'defaultValue' | 'disabled' | 'error' | 'maxLength' | 'minLength' | 'id' | 'label' | 'labelAccessibilityVisibility' | 'name' | 'readOnly' | 'required' | 'value'> {
|
|
46
43
|
/**
|
|
47
44
|
* @deprecated Use `label` instead.
|
|
@@ -51,11 +48,7 @@ export interface EmailFieldElementProps extends Pick<EmailFieldProps$1, 'autocom
|
|
|
51
48
|
}
|
|
52
49
|
export interface EmailFieldEvents extends Pick<EmailFieldProps$1, 'onBlur' | 'onChange' | 'onFocus' | 'onInput'> {
|
|
53
50
|
}
|
|
54
|
-
/**
|
|
55
|
-
* The email field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
56
|
-
*
|
|
57
|
-
* @publicDocs
|
|
58
|
-
*/
|
|
51
|
+
/** @publicDocs */
|
|
59
52
|
export interface EmailFieldElementEvents {
|
|
60
53
|
/**
|
|
61
54
|
* A callback fired when the email field loses focus.
|
|
@@ -82,11 +75,7 @@ export interface EmailFieldElementEvents {
|
|
|
82
75
|
*/
|
|
83
76
|
input?: CallbackEventListener<typeof tagName>;
|
|
84
77
|
}
|
|
85
|
-
/**
|
|
86
|
-
* The email field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
87
|
-
*
|
|
88
|
-
* @publicDocs
|
|
89
|
-
*/
|
|
78
|
+
/** @publicDocs */
|
|
90
79
|
export interface EmailFieldElementSlots {
|
|
91
80
|
/**
|
|
92
81
|
* Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.
|
|
@@ -38,10 +38,7 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
|
|
|
38
38
|
}) | null;
|
|
39
39
|
|
|
40
40
|
declare const tagName = "s-form";
|
|
41
|
-
/**
|
|
42
|
-
* Configure the following properties on the form component.
|
|
43
|
-
* @publicDocs
|
|
44
|
-
*/
|
|
41
|
+
/** @publicDocs */
|
|
45
42
|
export interface FormElementProps extends Pick<FormProps$1, 'disabled' | 'id'> {
|
|
46
43
|
}
|
|
47
44
|
export interface FormEvents extends Pick<FormProps$1, 'onSubmit'> {
|
|
@@ -50,11 +47,7 @@ export interface FormEvents extends Pick<FormProps$1, 'onSubmit'> {
|
|
|
50
47
|
*/
|
|
51
48
|
onSubmit?: () => void;
|
|
52
49
|
}
|
|
53
|
-
/**
|
|
54
|
-
* The form component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
55
|
-
*
|
|
56
|
-
* @publicDocs
|
|
57
|
-
*/
|
|
50
|
+
/** @publicDocs */
|
|
58
51
|
export interface FormElementEvents {
|
|
59
52
|
/**
|
|
60
53
|
* A callback fired when the form is submitted.
|
|
@@ -102,9 +102,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base
|
|
|
102
102
|
}
|
|
103
103
|
|
|
104
104
|
declare const tagName = "s-grid";
|
|
105
|
-
/**
|
|
106
|
-
* @publicDocs
|
|
107
|
-
*/
|
|
105
|
+
/** @publicDocs */
|
|
108
106
|
export interface GridElementProps extends Pick<GridProps$1, 'accessibilityLabel' | 'accessibilityRole' | 'accessibilityVisibility' | 'alignContent' | 'alignItems' | 'background' | 'blockSize' | 'border' | 'borderColor' | 'borderRadius' | 'borderStyle' | 'borderWidth' | 'columnGap' | 'display' | 'gap' | 'gridTemplateColumns' | 'gridTemplateRows' | 'id' | 'inlineSize' | 'justifyContent' | 'justifyItems' | 'maxBlockSize' | 'maxInlineSize' | 'minBlockSize' | 'minInlineSize' | 'overflow' | 'padding' | 'paddingBlock' | 'paddingBlockEnd' | 'paddingBlockStart' | 'paddingInline' | 'paddingInlineEnd' | 'paddingInlineStart' | 'placeContent' | 'placeItems' | 'rowGap'> {
|
|
109
107
|
/**
|
|
110
108
|
* Controls how the grid's rows are distributed along the block (column) axis when there is extra space. Set to an empty string to use the default.
|
|
@@ -46,9 +46,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base
|
|
|
46
46
|
}
|
|
47
47
|
|
|
48
48
|
declare const tagName = "s-grid-item";
|
|
49
|
-
/**
|
|
50
|
-
* @publicDocs
|
|
51
|
-
*/
|
|
49
|
+
/** @publicDocs */
|
|
52
50
|
export interface GridItemElementProps extends Pick<GridItemProps$1, 'accessibilityLabel' | 'accessibilityRole' | 'accessibilityVisibility' | 'background' | 'blockSize' | 'border' | 'borderColor' | 'borderRadius' | 'borderStyle' | 'borderWidth' | 'display' | 'gridColumn' | 'gridRow' | 'id' | 'inlineSize' | 'maxBlockSize' | 'maxInlineSize' | 'minBlockSize' | 'minInlineSize' | 'overflow' | 'padding' | 'paddingBlock' | 'paddingBlockEnd' | 'paddingBlockStart' | 'paddingInline' | 'paddingInlineEnd' | 'paddingInlineStart'> {
|
|
53
51
|
/**
|
|
54
52
|
* The background color of the grid item.
|
|
@@ -26,10 +26,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base
|
|
|
26
26
|
}
|
|
27
27
|
|
|
28
28
|
declare const tagName = "s-heading";
|
|
29
|
-
/**
|
|
30
|
-
* The element props interface for the Heading component.
|
|
31
|
-
* @publicDocs
|
|
32
|
-
*/
|
|
29
|
+
/** @publicDocs */
|
|
33
30
|
export interface HeadingElementProps extends Pick<HeadingProps$1, 'accessibilityRole' | 'id'> {
|
|
34
31
|
}
|
|
35
32
|
export interface HeadingElement extends HeadingElementProps, Omit<HTMLElement, 'id'> {
|
|
@@ -38,20 +38,14 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
|
|
|
38
38
|
}) | null;
|
|
39
39
|
|
|
40
40
|
declare const tagName = "s-link";
|
|
41
|
-
/**
|
|
42
|
-
* Configure the following properties on the link component.
|
|
43
|
-
* @publicDocs
|
|
44
|
-
*/
|
|
41
|
+
/** @publicDocs */
|
|
45
42
|
export interface LinkElementProps extends Pick<LinkProps$1, 'accessibilityLabel' | 'command' | 'commandFor' | 'href' | 'id' | 'interestFor' | 'lang' | 'target' | 'tone'> {
|
|
46
43
|
target?: Extract<LinkProps$1['target'], 'auto' | '_blank'>;
|
|
47
44
|
tone?: Extract<LinkProps$1['tone'], 'auto' | 'neutral'>;
|
|
48
45
|
}
|
|
49
46
|
export interface LinkEvents extends Pick<LinkProps$1, 'onClick'> {
|
|
50
47
|
}
|
|
51
|
-
/**
|
|
52
|
-
* The link component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
53
|
-
* @publicDocs
|
|
54
|
-
*/
|
|
48
|
+
/** @publicDocs */
|
|
55
49
|
export interface LinkElementEvents {
|
|
56
50
|
/**
|
|
57
51
|
* A callback fired when the link is clicked, before navigating to the location specified by `href`.
|
|
@@ -26,10 +26,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base
|
|
|
26
26
|
}
|
|
27
27
|
|
|
28
28
|
declare const tagName = "s-list-item";
|
|
29
|
-
/**
|
|
30
|
-
* The element props interface for the ListItem component.
|
|
31
|
-
* @publicDocs
|
|
32
|
-
*/
|
|
29
|
+
/** @publicDocs */
|
|
33
30
|
export interface ListItemElementProps extends Pick<ListItemProps$1, 'id'> {
|
|
34
31
|
}
|
|
35
32
|
export interface ListItemElement extends ListItemElementProps, Omit<HTMLElement, 'id'> {
|
|
@@ -41,7 +41,7 @@ declare const tagName = "s-map-marker";
|
|
|
41
41
|
/** @publicDocs */
|
|
42
42
|
export interface MapMarkerElementProps extends Pick<MapMarkerProps$1, 'accessibilityLabel' | 'blockSize' | 'command' | 'commandFor' | 'clusterable' | 'inlineSize' | 'latitude' | 'longitude'> {
|
|
43
43
|
/**
|
|
44
|
-
* Sets the action the `commandFor` target should take when this
|
|
44
|
+
* Sets the action the `commandFor` target should take when this component is activated. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).
|
|
45
45
|
*
|
|
46
46
|
* - `--auto`: a default action for the target component.
|
|
47
47
|
* - `--show`: shows the target component.
|
|
@@ -52,7 +52,7 @@ export interface MapMarkerElementProps extends Pick<MapMarkerProps$1, 'accessibi
|
|
|
52
52
|
*/
|
|
53
53
|
command?: Extract<MapMarkerProps$1['command'], '--auto' | '--show' | '--hide' | '--toggle'>;
|
|
54
54
|
/**
|
|
55
|
-
* The ID of
|
|
55
|
+
* The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
|
|
56
56
|
*/
|
|
57
57
|
commandFor?: MapMarkerProps$1['commandFor'];
|
|
58
58
|
}
|
|
@@ -68,10 +68,7 @@ export interface MapMarkerElementEvents {
|
|
|
68
68
|
*/
|
|
69
69
|
click?: CallbackEventListener<typeof tagName>;
|
|
70
70
|
}
|
|
71
|
-
/**
|
|
72
|
-
* The named slots for the map marker component. Slots allow you to insert custom content into specific areas of the marker.
|
|
73
|
-
* @publicDocs
|
|
74
|
-
*/
|
|
71
|
+
/** @publicDocs */
|
|
75
72
|
export interface MapMarkerElementSlots {
|
|
76
73
|
/**
|
|
77
74
|
* A custom graphic element to use as the marker. If not provided, the map provider’s default marker pin is displayed.
|
|
@@ -32,19 +32,12 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
|
|
|
32
32
|
}) | null;
|
|
33
33
|
|
|
34
34
|
declare const tagName = "s-money-field";
|
|
35
|
-
/**
|
|
36
|
-
* Configure the following properties on the money field component.
|
|
37
|
-
* @publicDocs
|
|
38
|
-
*/
|
|
35
|
+
/** @publicDocs */
|
|
39
36
|
export interface MoneyFieldElementProps extends Pick<MoneyFieldProps$1, 'autocomplete' | 'defaultValue' | 'disabled' | 'error' | 'id' | 'label' | 'labelAccessibilityVisibility' | 'max' | 'min' | 'name' | 'readOnly' | 'required' | 'step' | 'value'> {
|
|
40
37
|
}
|
|
41
38
|
export interface MoneyFieldEvents extends Pick<MoneyFieldProps$1, 'onBlur' | 'onChange' | 'onFocus' | 'onInput'> {
|
|
42
39
|
}
|
|
43
|
-
/**
|
|
44
|
-
* The money field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
45
|
-
*
|
|
46
|
-
* @publicDocs
|
|
47
|
-
*/
|
|
40
|
+
/** @publicDocs */
|
|
48
41
|
export interface MoneyFieldElementEvents {
|
|
49
42
|
/**
|
|
50
43
|
* A callback fired when the money field loses focus.
|
|
@@ -68,10 +68,7 @@ declare module 'preact' {
|
|
|
68
68
|
}
|
|
69
69
|
|
|
70
70
|
declare const tagName = "s-number-field";
|
|
71
|
-
/**
|
|
72
|
-
* Configure the following properties on the number field component.
|
|
73
|
-
* @publicDocs
|
|
74
|
-
*/
|
|
71
|
+
/** @publicDocs */
|
|
75
72
|
export interface NumberFieldElementProps extends Pick<NumberFieldProps$1, 'autocomplete' | 'controls' | 'defaultValue' | 'disabled' | 'error' | 'icon' | 'inputMode' | 'id' | 'label' | 'labelAccessibilityVisibility' | 'max' | 'min' | 'name' | 'prefix' | 'readOnly' | 'required' | 'step' | 'suffix' | 'value'> {
|
|
76
73
|
icon?: IconProps['type'];
|
|
77
74
|
/**
|
|
@@ -82,11 +79,7 @@ export interface NumberFieldElementProps extends Pick<NumberFieldProps$1, 'autoc
|
|
|
82
79
|
}
|
|
83
80
|
export interface NumberFieldEvents extends Pick<NumberFieldProps$1, 'onBlur' | 'onChange' | 'onFocus' | 'onInput'> {
|
|
84
81
|
}
|
|
85
|
-
/**
|
|
86
|
-
* The number field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
87
|
-
*
|
|
88
|
-
* @publicDocs
|
|
89
|
-
*/
|
|
82
|
+
/** @publicDocs */
|
|
90
83
|
export interface NumberFieldElementEvents {
|
|
91
84
|
/**
|
|
92
85
|
* A callback fired when the number field loses focus.
|
|
@@ -113,11 +106,7 @@ export interface NumberFieldElementEvents {
|
|
|
113
106
|
*/
|
|
114
107
|
input?: CallbackEventListener<typeof tagName>;
|
|
115
108
|
}
|
|
116
|
-
/**
|
|
117
|
-
* The number field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
118
|
-
*
|
|
119
|
-
* @publicDocs
|
|
120
|
-
*/
|
|
109
|
+
/** @publicDocs */
|
|
121
110
|
export interface NumberFieldElementSlots {
|
|
122
111
|
/**
|
|
123
112
|
* Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.
|
|
@@ -26,10 +26,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base
|
|
|
26
26
|
}
|
|
27
27
|
|
|
28
28
|
declare const tagName = "s-option";
|
|
29
|
-
/**
|
|
30
|
-
* Configure the following properties on the option component.
|
|
31
|
-
* @publicDocs
|
|
32
|
-
*/
|
|
29
|
+
/** @publicDocs */
|
|
33
30
|
export interface OptionElementProps extends Pick<OptionProps$1, 'accessibilityLabel' | 'defaultSelected' | 'disabled' | 'id' | 'selected' | 'value'> {
|
|
34
31
|
}
|
|
35
32
|
export interface OptionElement extends OptionElementProps, Omit<HTMLElement, 'id'> {
|
|
@@ -26,10 +26,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base
|
|
|
26
26
|
}
|
|
27
27
|
|
|
28
28
|
declare const tagName = "s-ordered-list";
|
|
29
|
-
/**
|
|
30
|
-
* The element props interface for the OrderedList component.
|
|
31
|
-
* @publicDocs
|
|
32
|
-
*/
|
|
29
|
+
/** @publicDocs */
|
|
33
30
|
export interface OrderedListElementProps extends OrderedListProps$1 {
|
|
34
31
|
}
|
|
35
32
|
export interface OrderedListElement extends OrderedListElementProps, Omit<HTMLElement, 'id'> {
|
|
@@ -26,13 +26,21 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base
|
|
|
26
26
|
}
|
|
27
27
|
|
|
28
28
|
declare const tagName = "s-paragraph";
|
|
29
|
-
/**
|
|
30
|
-
* The element props interface for the Paragraph component.
|
|
31
|
-
* @publicDocs
|
|
32
|
-
*/
|
|
29
|
+
/** @publicDocs */
|
|
33
30
|
export interface ParagraphElementProps extends Pick<ParagraphProps$1, 'accessibilityVisibility' | 'color' | 'dir' | 'id' | 'lang' | 'tone' | 'type'> {
|
|
34
31
|
color?: Extract<ParagraphProps$1['color'], 'subdued' | 'base'>;
|
|
35
32
|
tone?: Extract<ParagraphProps$1['tone'], 'auto' | 'info' | 'success' | 'warning' | 'critical' | 'neutral' | 'custom'>;
|
|
33
|
+
/**
|
|
34
|
+
* The semantic type and styling treatment for the paragraph content.
|
|
35
|
+
*
|
|
36
|
+
* Other presentation properties on `s-paragraph` override the default styling.
|
|
37
|
+
*
|
|
38
|
+
* - `paragraph`: A semantic type that indicates the text is a structural grouping of related content.
|
|
39
|
+
* - `small`: A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand.
|
|
40
|
+
*
|
|
41
|
+
* @default 'paragraph'
|
|
42
|
+
*/
|
|
43
|
+
type?: Extract<ParagraphProps$1['type'], 'paragraph' | 'small'>;
|
|
36
44
|
}
|
|
37
45
|
export interface ParagraphElement extends ParagraphElementProps, Omit<HTMLElement, 'id' | 'dir' | 'lang'> {
|
|
38
46
|
}
|
|
@@ -38,19 +38,12 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
|
|
|
38
38
|
}) | null;
|
|
39
39
|
|
|
40
40
|
declare const tagName = "s-password-field";
|
|
41
|
-
/**
|
|
42
|
-
* Configure the following properties on the password field component.
|
|
43
|
-
* @publicDocs
|
|
44
|
-
*/
|
|
41
|
+
/** @publicDocs */
|
|
45
42
|
export interface PasswordFieldElementProps extends Pick<PasswordFieldProps$1, 'autocomplete' | 'defaultValue' | 'disabled' | 'error' | 'id' | 'label' | 'labelAccessibilityVisibility' | 'maxLength' | 'minLength' | 'name' | 'readOnly' | 'required' | 'value'> {
|
|
46
43
|
}
|
|
47
44
|
export interface PasswordFieldEvents extends Pick<PasswordFieldProps$1, 'onBlur' | 'onChange' | 'onFocus' | 'onInput'> {
|
|
48
45
|
}
|
|
49
|
-
/**
|
|
50
|
-
* The password field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
51
|
-
*
|
|
52
|
-
* @publicDocs
|
|
53
|
-
*/
|
|
46
|
+
/** @publicDocs */
|
|
54
47
|
export interface PasswordFieldElementEvents {
|
|
55
48
|
/**
|
|
56
49
|
* A callback fired when the password field loses focus.
|
|
@@ -77,11 +70,7 @@ export interface PasswordFieldElementEvents {
|
|
|
77
70
|
*/
|
|
78
71
|
input?: CallbackEventListener<typeof tagName>;
|
|
79
72
|
}
|
|
80
|
-
/**
|
|
81
|
-
* The password field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
82
|
-
*
|
|
83
|
-
* @publicDocs
|
|
84
|
-
*/
|
|
73
|
+
/** @publicDocs */
|
|
85
74
|
export interface PasswordFieldElementSlots {
|
|
86
75
|
/**
|
|
87
76
|
* Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.
|
|
@@ -38,10 +38,7 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
|
|
|
38
38
|
}) | null;
|
|
39
39
|
|
|
40
40
|
declare const tagName = "s-phone-field";
|
|
41
|
-
/**
|
|
42
|
-
* Configure the following properties on the phone field component.
|
|
43
|
-
* @publicDocs
|
|
44
|
-
*/
|
|
41
|
+
/** @publicDocs */
|
|
45
42
|
export interface PhoneFieldElementProps extends Pick<PhoneFieldProps$1, 'autocomplete' | 'defaultValue' | 'disabled' | 'error' | 'id' | 'label' | 'labelAccessibilityVisibility' | 'name' | 'readOnly' | 'required' | 'value' | 'type'> {
|
|
46
43
|
/**
|
|
47
44
|
* @deprecated Use `label` instead.
|
|
@@ -51,11 +48,7 @@ export interface PhoneFieldElementProps extends Pick<PhoneFieldProps$1, 'autocom
|
|
|
51
48
|
}
|
|
52
49
|
export interface PhoneFieldEvents extends Pick<PhoneFieldProps$1, 'onBlur' | 'onChange' | 'onFocus' | 'onInput'> {
|
|
53
50
|
}
|
|
54
|
-
/**
|
|
55
|
-
* The phone field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
56
|
-
*
|
|
57
|
-
* @publicDocs
|
|
58
|
-
*/
|
|
51
|
+
/** @publicDocs */
|
|
59
52
|
export interface PhoneFieldElementEvents {
|
|
60
53
|
/**
|
|
61
54
|
* A callback fired when the phone field loses focus.
|
|
@@ -82,11 +75,7 @@ export interface PhoneFieldElementEvents {
|
|
|
82
75
|
*/
|
|
83
76
|
input?: CallbackEventListener<typeof tagName>;
|
|
84
77
|
}
|
|
85
|
-
/**
|
|
86
|
-
* The phone field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
87
|
-
*
|
|
88
|
-
* @publicDocs
|
|
89
|
-
*/
|
|
78
|
+
/** @publicDocs */
|
|
90
79
|
export interface PhoneFieldElementSlots {
|
|
91
80
|
/**
|
|
92
81
|
* Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.
|
|
@@ -38,18 +38,12 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
|
|
|
38
38
|
}) | null;
|
|
39
39
|
|
|
40
40
|
declare const tagName = "s-press-button";
|
|
41
|
-
/**
|
|
42
|
-
* Configure the following properties on the press button component.
|
|
43
|
-
* @publicDocs
|
|
44
|
-
*/
|
|
41
|
+
/** @publicDocs */
|
|
45
42
|
export interface PressButtonElementProps extends Pick<PressButtonProps$1, 'accessibilityLabel' | 'id' | 'inlineSize' | 'lang' | 'disabled' | 'loading' | 'pressed' | 'defaultPressed'> {
|
|
46
43
|
}
|
|
47
44
|
export interface PressButtonEvents extends Pick<PressButtonProps$1, 'onClick' | 'onBlur' | 'onFocus'> {
|
|
48
45
|
}
|
|
49
|
-
/**
|
|
50
|
-
* The press button component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
51
|
-
* @publicDocs
|
|
52
|
-
*/
|
|
46
|
+
/** @publicDocs */
|
|
53
47
|
export interface PressButtonElementEvents {
|
|
54
48
|
/**
|
|
55
49
|
* A callback fired when the button is clicked.
|
|
@@ -20,16 +20,14 @@ export interface BaseElementProps<TClass = HTMLElement> {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
declare const tagName = "s-progress";
|
|
23
|
-
/**
|
|
24
|
-
* @publicDocs
|
|
25
|
-
*/
|
|
23
|
+
/** @publicDocs */
|
|
26
24
|
export interface ProgressElementProps extends Pick<ProgressProps$1, 'accessibilityLabel' | 'id' | 'max' | 'tone' | 'value'> {
|
|
27
25
|
/**
|
|
28
26
|
* A label announced by assistive technologies that describes what is progressing. Use this to provide context about the ongoing task, such as "Loading order details" or "Uploading file".
|
|
29
27
|
*/
|
|
30
28
|
accessibilityLabel?: ProgressProps$1['accessibilityLabel'];
|
|
31
29
|
/**
|
|
32
|
-
* The total amount of work the task requires. Must be a value greater than 0 and a valid floating point number.
|
|
30
|
+
* The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.
|
|
33
31
|
*
|
|
34
32
|
* Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).
|
|
35
33
|
*
|
|
@@ -46,7 +44,7 @@ export interface ProgressElementProps extends Pick<ProgressProps$1, 'accessibili
|
|
|
46
44
|
*/
|
|
47
45
|
tone?: Extract<ProgressProps$1['tone'], 'auto' | 'critical'>;
|
|
48
46
|
/**
|
|
49
|
-
* 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.
|
|
47
|
+
* 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.
|
|
50
48
|
*
|
|
51
49
|
* Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).
|
|
52
50
|
*/
|
|
@@ -46,9 +46,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base
|
|
|
46
46
|
}
|
|
47
47
|
|
|
48
48
|
declare const tagName = "s-scroll-box";
|
|
49
|
-
/**
|
|
50
|
-
* @publicDocs
|
|
51
|
-
*/
|
|
49
|
+
/** @publicDocs */
|
|
52
50
|
export interface ScrollBoxElementProps extends Pick<ScrollBoxProps$1, 'accessibilityLabel' | 'accessibilityRole' | 'accessibilityVisibility' | 'background' | 'blockSize' | 'border' | 'borderColor' | 'borderRadius' | 'borderStyle' | 'borderWidth' | 'display' | 'id' | 'inlineSize' | 'maxBlockSize' | 'maxInlineSize' | 'minBlockSize' | 'minInlineSize' | 'overflow' | 'padding' | 'paddingBlock' | 'paddingBlockEnd' | 'paddingBlockStart' | 'paddingInline' | 'paddingInlineEnd' | 'paddingInlineStart'> {
|
|
53
51
|
/**
|
|
54
52
|
* The background color of the scroll box.
|