You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Sets the action the `commandFor` target should take when this marker is activated. See the documentation of particular components for the actions they support. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).
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.
* The ID of a component that should respond to activations (for example, clicks) on this component. Refer to the `command` property for how to control the behavior of the target. Learn more about the [`commandfor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
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).
* 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.
48
48
*
49
49
* Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).
* - `'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}/polaris-web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.
* 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.
2064
2061
*
2065
-
* @default '' meaning no specific kind of phone number
* Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.
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.
2163
2158
*
2164
2159
* A comma-separated list of days. Whitespace is allowed after commas.
* It’s important to note that this callback will be called only when the user **finishes editing** the date,
2243
-
* and it’s called right after the `onChange` callback.
2244
-
* The field is **not** validated on every change to the input. Once the buyer has signalled that
2245
-
* 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.
* 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.
3077
3070
*
3078
3071
* Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).
3079
3072
*/
3080
3073
value?: number;
3081
3074
/**
3082
-
* 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.
3083
3076
*
3084
3077
* Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).
* - `base`: Applies padding that is appropriate for the element. Note that it may result in no padding if Shopify believes this is the right design decision in a particular context.
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.
3217
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.
* Sets the action the `commandFor` target should take when this marker is activated. See the documentation of particular components for the actions they support. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).
4335
+
* 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).
4338
4336
*
4339
4337
* - `--auto`: a default action for the target component.
* The ID of a component that should respond to activations (for example, clicks) on this component. Refer to the `command` property for how to control the behavior of the target. Learn more about the [`commandfor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
4346
+
* 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).
* 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).
45
41
*/
46
42
commandFor?: string;
47
43
/**
48
-
* Sets the action the `commandFor` should take when this clickable is activated.
44
+
* Sets the action the `commandFor` target should take when this component is activated.
49
45
*
50
-
* See the documentation of particular components for the actions they support.
46
+
* - `--auto`: A default action for the target component.
47
+
* - `--show`: Shows the target component.
48
+
* - `--hide`: Hides the target component.
49
+
* - `--toggle`: Toggles the target component.
50
+
* - `--copy`: Copies the target clipboard item.
51
51
*
52
-
* - `--auto`: a default action for the target component.
53
-
* - `--show`: shows the target component.
54
-
* - `--hide`: hides the target component.
55
-
* - `--toggle`: toggles the target component.
56
-
* - `--copy`: copies the target ClipboardItem.
52
+
* Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).
* The `id` of a component that should respond to activations on this button. See `command` for how to control the behavior of the target.
357
+
* 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).
* The `id` of a component that should respond to activations on this button. See `command` for how to control the behavior of the target.
413
+
* 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).
* The identifier that specifies where in Shopify's UI your code is being injected. This will be one of the targets you have included in your extension's configuration file.
* Learn more about [targets](/docs/api/customer-account-ui-extensions/{API_VERSION}/targets) and [target configuration](/docs/api/customer-account-ui-extensions/{API_VERSION}#configuration).
289
288
*
290
289
* @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.
0 commit comments